TextEditSettings.Mask Property

Gets or sets a mask expression. This is a dependency property.

Namespace: DevExpress.Xpf.Editors.Settings

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

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Core, DevExpress.Wpf.Core

Declaration

C#

public string Mask { get; set; }

VB.NET

Public Property Mask As String

Property Value

Type	Description
String	A string representing a mask expression.

Property Paths

You can access this nested property as listed below:

Object Type	Path to Mask
TokenEditorBehavior	.TokenEditSettings .Mask

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 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.

XAML

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>

wpf-data-grid-refresh-on-timer/CS/RefreshOnTimer/MainWindow.xaml#L22

<Setter.Value>
    <dxe:TextEditSettings MaskType="Numeric" Mask="f" MaskUseAsDisplayFormat="True" />
</Setter.Value>

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>

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

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