MaskProperties.EditMask Property

Gets or sets a mask expression.

Namespace: DevExpress.XtraEditors.Mask

Assembly: DevExpress.XtraEditors.v18.2.dll

Declaration

C#

public virtual string EditMask { get; set; }

VB.NET

Public Overridable Property EditMask As String

Property Value

Type	Default	Description
String	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 Mask Editors Overview 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#

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

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

how-to-create-a-masked-editor-with-specified-ranges-for-every-mask-part-e3379/CS/RangedMaskSample/MaskButtonEdit.cs#L49

patchedMask.Assign(mask);
patchedMask.EditMask = Properties.Mask.EditMask;

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

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

how-to-change-format-for-entering-time-value-in-the-appointment-editing-form-t281927/CS/CustomAppointmentFormWithSeconds/CustomAppointmentForm.cs#L38

InitializeComponent();
this.edtStartTime.Properties.Mask.EditMask = "T";
this.edtEndTime.Properties.Mask.EditMask = "T";

how-to-create-an-ip-address-editor-to-cycle-through-every-part-of-an-ip-address-e2443/CS/IPAddressEditor/RepositoryItemIPAddressEdit.cs#L94

    DisplayFormat.FormatString = EditMask;
    Mask.EditMask = EditMask;
}

VB.NET

how-to-create-a-masked-editor-with-specified-ranges-for-every-mask-part-e3379/VB/RangedMaskSample/MaskButtonEdit.vb#L47

patchedMask.Assign(mask)
patchedMask.EditMask = Properties.Mask.EditMask

XAF_how-to-dynamically-change-mask-settings-based-on-the-current-object-t236972/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

how-to-change-format-for-entering-time-value-in-the-appointment-editing-form-t281927/VB/CustomAppointmentFormWithSeconds/CustomAppointmentForm.vb#L36

InitializeComponent()
Me.edtStartTime.Properties.Mask.EditMask = "T"
Me.edtEndTime.Properties.Mask.EditMask = "T"

how-to-create-an-ip-address-editor-to-cycle-through-every-part-of-an-ip-address-e2443/VB/IPAddressEditor/RepositoryItemIPAddressEdit.vb#L79

    DisplayFormat.FormatString = EditMask
    Mask.EditMask = EditMask
End Sub

how-to-edit-timespan-data-in-standalone-and-in-place-mode-e1976/VB/TimeSpanEditor/TimeSpanEditor.vb#L91

    DisplayFormat.FormatString = EditMask
    Mask.EditMask = EditMask
End Sub