MaskChars Property

Gets an array containing the possible masking characters.

Syntax

Visual Basic
C#

'Declaration
 
Protected Overridable ReadOnly Property MaskChars As Char()

'Usage
 
Dim instance As TextBoxArea

Dim value() As Char

 

value = instance.MaskChars

protected virtual char[] MaskChars {get;}

Property Value

An array containing the possible masking characters. Unless overridden, #, 9, A, a ,@ and &.

Remarks

The following table provides a list of the default mask characters:

#	Digits or white space
9	Digits only
A	Alpha-numeric values only
a	Alpha-numeric values or white space
@	Letters only
&	Any printable character (ascii characters from 32 to 126 and 128 to 255)

The following table provides a list of characters which are not mask characters but still affect the formatting of the text:

>	When used as the first character of a mask, it converts all inputted characters to uppercase. When used elsewhere within the mask, it is considered as a literal.
<	When used as the first character of a mask, it converts all inputted characters to lowercase. When used elsewhere within the mask, it is considered as a literal.
\	The character following this character will always be considered as a literal. For example, \9 will be the 9 literal instead of the digits mask character.

All other characters are considered as literals.

When overriding MaskChars in a derived class, IsCharValid must also be overridden to return true if the inputted char is valid for the new mask character.

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

TextBoxArea Class
TextBoxArea Members