TextEditSettings.MaskType Property

Gets or sets the mask type. This is a dependency property.

Namespace: DevExpress.Xpf.Editors.Settings

Assembly: DevExpress.Xpf.Core.v19.2.dll

Declaration

C#

public MaskType MaskType { get; set; }

VB.NET

Public Property MaskType As MaskType

Property Value

Type	Description
MaskType	One of the MaskType enumeration values.

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 the full-functional regular expressions.
Regular	Specifies that the mask should be created using the simplified regular expression syntax.
Simple	Specifies that the mask should use the simplified syntax.
TimeSpan	Specifies that the editor should accept time interval values, and that the mask string must use the TimeSpan format syntax.
TimeSpanAdvancingCaret	The TimeSpan mask mode with the caret automatic movement feature. After an end user enters and completes a specific portion of a time span value, the caret automatically moves to the following part of the time span value that can be edited.

Property Paths

You can access this nested property as listed below:

Object Type	Path to MaskType
TokenEditorBehavior	.TokenEditSettings.MaskType

Remarks

To learn more, see Masked Input.

Example

Xaml

<dxg:GridControl ItemsSource="{Binding Customers}">
    <dxg:GridControl.View>
        <dxg:TableView />
    </dxg:GridControl.View>
    <dxg:GridColumn FieldName="Name"/>
    <dxg:GridColumn FieldName="City"/>
    <dxg:GridColumn FieldName="Birthday">
        <dxg:GridColumn.EditSettings>
            <dxe:TextEditSettings Mask="d" MaskType="DateTime" MaskUseAsDisplayFormat="True"/>
        </dxg:GridColumn.EditSettings>
    </dxg:GridColumn>
</dxg:GridControl>

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#

how-to-style-gridcontrols-summary-items-separately-when-summary-items-are-aligned-by-columns-e4998/VB/DXSample/MainWindow.xaml#L37

<dxg:GridColumn.EditSettings>
    <dxe:TextEditSettings Mask="c" MaskType="Numeric" MaskUseAsDisplayFormat="True"/>
</dxg:GridColumn.EditSettings>

Reporting_how-to-remove-standard-bar-items-and-add-custom-ones-to-the-documentviewer-toolbar-e2974/CS/WpfApplication1/MainWindow.xaml#L152

<dxb:BarEditItem.EditSettings>
    <dxe:TextEditSettings AllowNullInput="True" HorizontalContentAlignment="Center" MaskType="RegEx" Mask="\d{0,6}"/>
</dxb:BarEditItem.EditSettings>

Reporting_how-to-show-a-ribbon-preview-window-for-link-e4407/CS/RibbonPrintPreviewDemo/MainWindow.xaml#L152

<dxb:BarEditItem.EditSettings>
    <dxe:TextEditSettings AllowNullInput="True" HorizontalContentAlignment="Center" MaskType="RegEx" Mask="\d{0,6}" />
</dxb:BarEditItem.EditSettings>

Reporting_wpf-end-user-report-designer-how-to-hide-a-property-in-the-properties-window-t285448/CS/Dictionary1.xaml#L171

<dxpg:PropertyDefinition.EditSettings>
    <dxe:TextEditSettings MaskType="RegEx" Mask="{x:Static propertygrid:ReportDesignerPropertyGridControl.PageRangeMask}" MaskUseAsDisplayFormat="True" />
</dxpg:PropertyDefinition.EditSettings>

how-to-specify-editors-for-displayed-properties-t324581/CS/MainWindow.xaml#L27

<dxprg:PropertyDefinition.EditSettings>
    <dxe:TextEditSettings MaskType="Simple" Mask="[phone]"/>
</dxprg:PropertyDefinition.EditSettings>