RepositoryItemTextEdit.Mask Property

Provides access to the editor’s mask settings.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v18.2.dll

Declaration

C#

[DXCategory("Format")]
public virtual MaskProperties Mask { get; }

VB.NET

<DXCategory("Format")>
Public Overridable ReadOnly Property Mask As MaskProperties

Property Value

Type	Description
MaskProperties	A MaskProperties object which provides the editor’s mask settings.

Remarks

Applying a mask to the editor allows the text end-users can enter to be restricted. If masked mode is enabled, the editor validates the text against the mask and only allows data to be entered that satisfies the mask expression. To enable masked mode for an editor, set the MaskProperties.MaskType property and specify the mask using the MaskProperties.EditMask property. Refer to the Mask Editors Overview document for more information on masks.

To disable masked mode, set the MaskProperties.MaskType property to the MaskType.None value.

Note

The following editors do not support editing in masked mode: LookUpEdit, GridLookUpEdit, MemoEdit, MemoExEdit and ImageComboBoxEdit.

Related GitHub Examples

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

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

{
    return base.Mask;
}

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

{
    return base.Mask;
}

how-to-edit-timespan-data-in-standalone-and-in-place-mode-e1976/CS/TimeSpanEditor/TimeSpanEditor.cs#L39

[Browsable(false)]
public override MaskProperties Mask { get { return base.Mask; } }
[Browsable(false)]

VB.NET

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

Get
    Return MyBase.Mask
End Get

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

Get
    Return MyBase.Mask
End Get

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

Get
    Return MyBase.Mask
End Get