TextEdit.Mask Property

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

Namespace: DevExpress.Xpf.Editors

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.

Remarks

When the editor’s value is set using the Text property, the editor’s value is of System.String type and the Numeric and DateTime mask types may apply incorrectly. Specify the editor’s value using the EditValue property to correctly apply mask settings.

Note

The following TextEdit descendants do not support the masked input:

• ComboBoxEdit
• LookUpEdit
• MemoEdit
• PopupColorEdit
• PopupImageEdit

Specify Mask in Design Time

You can use the Mask Editor to specify editor’s Mask.

Specify Mask in Code

Xaml

<!-- Long date -->
<dxe:TextEdit Mask="D" MaskType="DateTime"
    MaskUseAsDisplayFormat="True" />
<!-- Currency -->
<dxe:TextEdit Mask="c" MaskType="Numeric"
    MaskUseAsDisplayFormat="True" />
<!-- Email address -->
<dxe:TextEdit Mask="[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,4}"
    MaskType="RegEx" MaskUseAsDisplayFormat="True" />

To learn more, see Masked Input.

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

how-to-create-a-custom-spinedit-editor-that-supports-regex-masks-e4957/CS/CustomSpinEdit/MainWindow.xaml#L9

<StackPanel>
    <local:MySpinEdit Mask="(\d*)|(\d*,\d*)" MaskType="RegEx" DecimalValue="{Binding DoubleValue, UpdateSourceTrigger=PropertyChanged, Mode=TwoWay}"/>
    <local:MySpinEdit Mask="(\d*)|(\d*,\d*)" MaskType="RegEx" DecimalValue="{Binding IntegerValue, UpdateSourceTrigger=PropertyChanged, Mode=TwoWay}" ValueType="{x:Type sys:Int32}"/>

how-to-invoke-the-default-appointment-recurrence-dialog-from-a-custom-edit-appointment-form-e3796/CS/WpfApplication1/CustomAppointmentForm.xaml#L56

MaskType="DateTime" DisplayFormatString="{Binding TimeEditMask}"
Mask="{Binding TimeEditMask}"
EditValue="{Binding Controller.DisplayStartTime, Converter={StaticResource timeSpanToDateTimeConverter}}"

dxscheduler-for-wpf-complete-implementation-of-a-custom-edit-appointment-form-e3374/CS/CustomAppointmentForm.xaml#L128

<dxe:ButtonEdit Name="edtStartTime" MinWidth="150" MaskType="DateTime" DisplayFormatString="{Binding TimeEditMask}"
                Mask="{Binding TimeEditMask}" Grid.Row="0" Grid.Column="1"
                EditValue="{Binding Controller.DisplayStartTime, Converter={StaticResource timeSpanToDateTimeConverter}}" AllowDefaultButton="False"

dxscheduler-getting-started-create-a-custom-edit-appointment-form-e2499/CS/SchedulerCustomAppointmentForm/CustomAppointmentForm.xaml#L56

MaskType="DateTime" DisplayFormatString="{Binding TimeEditMask}"
Mask="{Binding TimeEditMask}"
EditValue="{Binding Controller.DisplayStartTime, Mode=TwoWay,

how-to-create-a-custom-edit-appointment-form-using-the-mvvm-pattern-t103885/CS/MVVMSchedulerApplication/HospitalAppointmentForm.xaml#L59

<dxe:TextEdit x:Name="edtStartTime" MinWidth="150" MaskType="DateTime" DisplayFormatString="{Binding TimeEditMask}"
              Mask="{Binding TimeEditMask}" Grid.Row="0" Grid.Column="1" Margin="6,0,0,0"
              EditValue ="{Binding DisplayStartTime, Converter={StaticResource timeSpanToDateTimeConverter}, UpdateSourceTrigger=PropertyChanged, Mode=TwoWay}">