MaskSettings Class

Contains mask settings.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v24.2.dll

Declaration

C#

public class MaskSettings :
    PropertiesBase

VB.NET

Public Class MaskSettings
    Inherits PropertiesBase

Related API Members

The following members return MaskSettings objects:

• ASPxButtonEdit.MaskSettings
• ASPxTextBox.MaskSettings
• ButtonEditProperties.MaskSettings
• TextBoxProperties.MaskSettings

Remarks

The MaskSettings class contains the settings that allow you to specify the input mask, error text, prompt char, and to define whether the literal characters of the mask are included in an editor’s value.

These settings can be accessed via the MaskSettings property of editor controls.

Example

• Zip code

<dx:ASPxTextBox ID="txtZip" runat="server">
    <MaskSettings Mask="00000" PromptChar="#" />
</dx:ASPxTextBox>

• Phone Number

<dx:ASPxTextBox ID="txtPhone" runat="server">
    <MaskSettings Mask="[phone]" IncludeLiterals="None" />
</dx:ASPxTextBox>

• Price

<dx:ASPxTextBox ID="txtPrice" runat="server" >
    <MaskSettings Mask="$<0..99999g>.<00..99>" IncludeLiterals="DecimalSymbol" />
</dx:ASPxTextBox>

• Date

<dx:ASPxDateEdit ID="dateEdit" runat="server" EditFormat="Custom" 
UseMaskBehavior="true" EditFormatString="MMMM dd, yyyy" >
</dx:ASPxDateEdit>

• Promo Code

<dx:ASPxTextBox ID="txtPromoCode" runat="server" >
    <MaskSettings ShowHints="true" Mask="<HOME|*BUSINESS>->aaaa-aaaa" />
</dx:ASPxTextBox>

MVC:

C#

@Html.DevExpress().TextBox(settings => {
    settings.Name = "textBox3";
    settings.Width = Unit.Percentage(100);
    settings.Properties.MaskSettings.Mask = "[phone]";
    settings.Properties.MaskSettings.IncludeLiterals = MaskIncludeLiteralsMode.None;
    settings.Properties.MaskSettings.ErrorText = "Invalid Phone Number";
    settings.Properties.ValidationSettings.Display = Display.Dynamic;
}).GetHtml()

Concepts

• Mask Types
• Mask (Web Forms)
• Mask Editing (MVC)

Online Demos

• Masked Input (Web Forms)
• Text Box - Features (MVC)

Implements

IStateManager

Inheritance

Object

StateManager

PropertiesBase

MaskSettings