Edit

Share via


MaskedTextBox.InsertKeyMode Property

Definition

Gets or sets the text insertion mode of the masked text box control.

public:
 property System::Windows::Forms::InsertKeyMode InsertKeyMode { System::Windows::Forms::InsertKeyMode get(); void set(System::Windows::Forms::InsertKeyMode value); };
public System.Windows.Forms.InsertKeyMode InsertKeyMode { get; set; }
member this.InsertKeyMode : System.Windows.Forms.InsertKeyMode with get, set
Public Property InsertKeyMode As InsertKeyMode

Property Value

An InsertKeyMode value that indicates the current insertion mode. The default is Default.

Exceptions

An invalid InsertKeyMode value was supplied when setting this property.

Remarks

The InsertKeyMode property controls the character insertion behavior of the MaskedTextBox control. The state of this property is defined by the InsertKeyMode enumeration, which can be always on, always off or set to respect the setting of the user's keyboard. This property supersedes the insertion mode of the keyboard. For example, if the keyboard is set to overwrite, but InsertKeyMode is set to Insert, the MaskedTextBox will operate in insert mode. The IsOverwriteMode property will access the true insertion mode of the MaskedTextBox.

If changing InsertKeyMode changes the value of IsOverwriteMode, MaskedTextBox will raise the IsOverwriteModeChanged event.

This property has no effect if no mask has been set.

Applies to

See also