This documentation is archived and is not being maintained.

MaskedTextBox.TextMaskFormat Property

Gets or sets a value that determines whether literals and prompt characters are included in the formatted string.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public MaskFormat TextMaskFormat { get; set; }

Property Value

Type: System.Windows.Forms.MaskFormat
One of the MaskFormat values. The default is IncludeLiterals.

ExceptionCondition
InvalidEnumArgumentException

Property set with a MaskFormat value that is not valid.

The TextMaskFormat property determines how the literal and prompt characters in the mask are processed when the generating the formatted string. More specifically, it determines whether literal characters, prompt characters, or both are included in the Text property. When prompt characters are excluded, they are transformed into spaces in the formatted string.

NoteNote:

The CutCopyMaskFormat property serves a similar purpose with respect to how the Text property is interpreted.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: