This topic has not yet been rated - Rate this topic

MaskedTextBox.InsertKeyMode Property

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

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
public InsertKeyMode InsertKeyMode { get; set; }

Property Value

Type: System.Windows.Forms.InsertKeyMode
An InsertKeyMode value that indicates the current insertion mode. The default is Default.
ExceptionCondition
InvalidEnumArgumentException

An invalid InsertKeyMode value was supplied when setting this property.

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.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
© 2013 Microsoft. All rights reserved.