MaskProperties.EditMask Property

Gets or sets a mask expression.

Namespace: DevExpress.XtraEditors.Mask

Assembly: DevExpress.XtraEditors.v25.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public virtual string EditMask { get; set; }

VB.NET

Public Overridable Property EditMask As String

Property Value

Type	Default	Description
String	System.String.Empty	A string representing a mask expression.

Remarks

Before you construct a mask, specify its type in the MaskProperties.MaskType property. Refer to the Input Mask document for information on the available mask types. This also provides links to documents that describe the mask syntaxes for different mask modes.

The code sample below illustrates how to create a mask for a phone number:

(a value is not entered)

(a value is entered)

C#

using DevExpress.XtraEditors;
using DevExpress.XtraEditors.Mask;

..

textEdit1.Properties.Mask.MaskType = MaskType.Simple;
textEdit1.Properties.Mask.EditMask = "[phone]";

VB.NET

Imports DevExpress.XtraEditors
Imports DevExpress.XtraEditors.Mask

textEdit1.Properties.Mask.MaskType = MaskType.Simple
textEdit1.Properties.Mask.EditMask = "[phone]"

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the EditMask property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-mvvm-best-practices/CS/POCODependencies/SimpleDependenciesUserControl.cs#L20

editor1.Properties.Mask.MaskType = DevExpress.XtraEditors.Mask.MaskType.Numeric;
editor1.Properties.Mask.EditMask = "n0";
editor1.Properties.Mask.UseMaskAsDisplayFormat = true;

xaf-how-to-dynamically-change-mask-settings-based-on-the-current-object/CS/ChangeEditMask.Module.Win/Controllers/WinChangeMaskController.cs#L17

textEdit.Properties.Mask.MaskType = DevExpress.XtraEditors.Mask.MaskType.DateTime;
textEdit.Properties.Mask.EditMask = "d";
break;

reporting-winforms-custom-controls-for-editing-report-content-in-print-preview/CS/RegisterCustomFieldEditor/Form1.cs#L38

dateRepositoryItem.Mask.MaskType = DevExpress.XtraEditors.Mask.MaskType.DateTime;
dateRepositoryItem.Mask.EditMask = "MMMM dd, yyyy";
EditingFieldExtensionsWin.Instance.RegisterEditor

VB.NET

winforms-mvvm-best-practices/VB/POCODependencies/SimpleDependenciesUserControl.vb#L20

editor1.Properties.Mask.MaskType = DevExpress.XtraEditors.Mask.MaskType.Numeric
editor1.Properties.Mask.EditMask = "n0"
editor1.Properties.Mask.UseMaskAsDisplayFormat = True

xaf-how-to-dynamically-change-mask-settings-based-on-the-current-object/VB/ChangeEditMask.Module.Win/Controllers/WinChangeMaskController.vb#L16

    textEdit.Properties.Mask.MaskType = DevExpress.XtraEditors.Mask.MaskType.DateTime
    textEdit.Properties.Mask.EditMask = "d"
Case BusinessObjects.EditMask.Time

reporting-winforms-custom-controls-for-editing-report-content-in-print-preview/VB/RegisterCustomFieldEditor/Form1.vb#L33

dateRepositoryItem.Mask.MaskType = DevExpress.XtraEditors.Mask.MaskType.DateTime
dateRepositoryItem.Mask.EditMask = "MMMM dd, yyyy"
EditingFieldExtensionsWin.Instance.RegisterEditor("DateEditor", "Date Editor", "Custom", dateRepositoryItem)