Xceed Toolkit Plus for WPF v5.0 Documentation
Xceed.Wpf.Toolkit Assembly / Xceed.Wpf.Toolkit Namespace / MaskedTextBox Class / Mask Property


In This Topic
    Mask Property (MaskedTextBox)
    In This Topic
    Gets or sets the input mask.
    Syntax
    'Declaration
     
    Public Property Mask As String
    'Usage
     
    Dim instance As MaskedTextBox
    Dim value As String
     
    instance.Mask = value
     
    value = instance.Mask
    public string Mask {get; set;}

    Property Value

    A string representing the mask.
    Remarks

    The IncludeLiteralsInValue property determines whether literals in the Mask are included in the Value.

    The IncludePromptInValue property determines whether prompt characters in the Mask are included in the Value.

    The following table lists the supported mask strings.

     

    Masking Element Description
    0 Digit, required. This element will accept any single digit between 0 and 9.
    9 Digit or space, optional.
    # Digit or space, optional. If this position is blank in the mask, it will be rendered as a space in the Text property. Plus (+) and minus (-) signs are allowed.
    L Letter, required. Restricts input to the ASCII letters a-z and A-Z. This mask element is equivalent to [a-zA-Z] in regular expressions.
    ? Letter, optional. Restricts input to the ASCII letters a-z and A-Z. This mask element is equivalent to [a-zA-Z]? in regular expressions.
    & Character, required. If the AsciiOnly property is set to true, this element behaves like the "L" element.
    C Character, optional. Any non-control character. If the AsciiOnly property is set to true, this element behaves like the "?" element.
    A Alphanumeric, optional. If the AsciiOnly property is set to true, the only characters it will accept are the ASCII letters a-z and A-Z.
    a Alphanumeric, optional. If the AsciiOnly property is set to true, the only characters it will accept are the ASCII letters a-z and A-Z.
    . Decimal placeholder. The actual display character used will be the decimal symbol appropriate to the format provider, as determined by the control's FormatProvider property.
    , Thousands placeholder. The actual display character used will be the thousands placeholder appropriate to the format provider, as determined by the control's FormatProvider property.
    : Time separator. The actual display character used will be the time symbol appropriate to the format provider, as determined by the control's FormatProvider property.
    / Date separator. The actual display character used will be the date symbol appropriate to the format provider, as determined by the control's FormatProvider property.
    $ Currency symbol. The actual character displayed will be the currency symbol appropriate to the format provider, as determined by the control's FormatProvider property.
    < Shift down. Converts all characters that follow to lowercase
    > Shift up. Converts all characters that follow to uppercase.
    Disable a previous shift up or shift down.
    \ Escape. Escapes a mask character, turning it into a literal. "\\" is the escape sequence for a backslash.

     

    Requirements

    Target Platforms: Windows 11, Windows 10, 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

    See Also