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 */
public MaskFormat get_TextMaskFormat ()

/** @property */
public void set_TextMaskFormat (MaskFormat value)

public function get TextMaskFormat () : MaskFormat

public function set TextMaskFormat (value : MaskFormat)

Not applicable.

Property Value

One of the MaskFormat values. The default is IncludeLiterals.

Exception typeCondition

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 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0
Show: