MaskProperties.MaskType Property

Gets or sets the mask type.

Namespace: DevExpress.XtraEditors.Mask

Assembly: DevExpress.XtraEditors.v18.2.dll

Declaration

C#

public virtual MaskType MaskType { get; set; }

VB.NET

Public Overridable Property MaskType As MaskType

Property Value

Type	Default	Description
MaskType	**None**	A MaskType value specifying the mask type used.

Available values:

Name	Description
None	Specifies that the mask feature is disabled.
DateTime	Specifies that the editor should accept date/time values and that the mask string must use the DateTime format syntax.
DateTimeAdvancingCaret	The DateTime mask mode with the caret automatic movement feature. After an end-user enters and completes a specific portion of a date/time value the caret automatically moves to the following part of the date/time value that can be edited.
Numeric	Specifies that the editor should accept numeric values and that the mask string must use the Numeric format syntax.
RegEx	Specifies that the mask should be created using full-functional regular expressions.
Regular	Specifies that the mask should be created using simplified regular expression syntax.
Simple	Specifies that the mask should use the simplified syntax.
Custom	Specifies that the editor uses a custom mask manager. To implement a custom mask manager which will deal with masks in a custom manner create a custom editor and override its CreateMaskManager method. This method should then supply a custom mask manager when the MaskProperties.MaskType property is set to Custom.

Remarks

Refer to the Mask Editors Overview document for information on choosing the mask type that meets your requirements.

The mask expression should be constructed using the syntax that is determined by the mask type. Use the MaskProperties.EditMask property to specify the mask expression.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the MaskType 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#L19

editor1.Dock = DockStyle.Top;
editor1.Properties.Mask.MaskType = DevExpress.XtraEditors.Mask.MaskType.Numeric;
editor1.Properties.Mask.EditMask = "n0";

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

case BusinessObjects.EditMask.Date:
    textEdit.Properties.Mask.MaskType = DevExpress.XtraEditors.Mask.MaskType.DateTime;
    textEdit.Properties.Mask.EditMask = "d";

how-to-display-custom-properties-for-the-layoutcontrolitem-in-the-customization-form-e1571/CS/S132265/MyLayoutControlItemPropertyWrapper.cs#L54

get {
    if (Editor != null) return Editor.Properties.Mask.MaskType;
    else return MaskType.None;

how-to-customize-separators-of-an-edit-mask-e487/CS/CustomCulture/Form1.cs#L30

private void Form1_Load(object sender, EventArgs e) {
    textEdit1.Properties.Mask.MaskType = DevExpress.XtraEditors.Mask.MaskType.Numeric;
    textEdit1.Properties.Mask.UseMaskAsDisplayFormat = true;

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

DisplayFormat.FormatString = EditMask;
Mask.MaskType = MaskType.DateTime;
Mask.EditMask = EditMask;

VB.NET

XAF_how-to-dynamically-change-mask-settings-based-on-the-current-object-t236972/VB/ChangeEditMask.Module.Win/Controllers/WinChangeMaskController.vb#L15

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

how-to-display-custom-properties-for-the-layoutcontrolitem-in-the-customization-form-e1571/VB/S132265/MyLayoutControlItemPropertyWrapper.vb#L84

If Editor IsNot Nothing Then
    Return Editor.Properties.Mask.MaskType
Else

how-to-customize-separators-of-an-edit-mask-e487/VB/CustomCulture/Form1.vb#L32

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
    textEdit1.Properties.Mask.MaskType = DevExpress.XtraEditors.Mask.MaskType.Numeric
    textEdit1.Properties.Mask.UseMaskAsDisplayFormat = True

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

DisplayFormat.FormatString = EditMask
Mask.MaskType = MaskType.DateTime
Mask.EditMask = EditMask

how-to-auto-complete-text-being-entered-with-a-custom-string-t190970/VB/MyTextEditWithCustomAutocomplete/MyTextEditWithCustomAutocomplete.vb#L13

Dim maskManager As MaskManager
If mask.MaskType = MaskType.Custom Then
    maskManager = New MyAutoCompleteMaskManager(New CustomMaskManagerCommon(New MaskManagerPlainTextState(String.Empty, 0, 0)))