DisplayTextMaskFormat Property

Gets or sets a value that determines how literals and prompt characters are displayed.

Syntax

Visual Basic (Declaration)
Visual Basic (Usage)
C#

<SRDescriptionAttribute("Indicates whether literals and/or prompt characters are displayed.")>
<SRCategoryAttribute("Behavior")>
<DefaultValueAttribute()>
<RefreshPropertiesAttribute(RefreshProperties.Repaint)>
Public Property DisplayTextMaskFormat As MaskFormat

Dim instance As MaskedTextBoxCell
Dim value As MaskFormat
 
instance.DisplayTextMaskFormat = value
 
value = instance.DisplayTextMaskFormat

[SRDescription("Indicates whether literals and/or prompt characters are displayed.")]
[SRCategory("Behavior")]
[DefaultValue()]
[RefreshProperties(RefreshProperties.Repaint)]
public MaskFormat DisplayTextMaskFormat {get; set;}

Property Value

One of the System.Windows.Forms.MaskFormat values. The default is System.Windows.Forms.MaskFormat.IncludePromptAndLiterals.

Exceptions

Exception	Description
System.ComponentModel.InvalidEnumArgumentException	The specified value is not a System.Windows.Forms.MaskFormat value.

Remarks

The DisplayTextMaskFormat property determines how text is interpreted when it is displayed in static painting. Specifically, it determines whether literal characters, prompt characters, or both are included when text is accessed. When prompt characters are excluded, they are transformed into spaces in the copied string.

The TextMaskFormat property serves a similar purpose with respect to how the text is interpreted.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

MaskedTextBoxCell Class
MaskedTextBoxCell Members