Skip to main content
A newer version of this page is available. .

PropertyEditor.EditMask Property

Specifies a mask expression for the current Property Editor’s control.

Namespace: DevExpress.ExpressApp.Editors

Assembly: DevExpress.ExpressApp.v19.1.dll

Declaration

public string EditMask { get; set; }

Property Value

Type Description
String

A string value representing a mask expression for the current Property Editor’s control.

Remarks

Using masks in editors is useful when the entered string should match a specific format. For instance, a text editor should accept date/time values in 24-hour format only, or only numeric values. Another example is entering a phone number within an editor (an end-user needs to enter only digits, while hyphens should be automatically skipped while editing). To support these and many other data input formats, the masked mode can be used. Use this property to specify a masked expression for the current Property Editor’s control. By default, this property returns the IModelCommonMemberViewItem.EditMask property value of the Application Model‘s node. This node can be accessed using the PropertyEditor.Model property.

The mask expression syntax depends on the mask type. The Mask Types section of the Mask Editors Overview topic, provides general information on available mask types in WinForms and ASP.NET applications. To learn more about mask types in Mobile applications, refer to the format (for numeric and DateTime editors) and mask topic (for string editors).

If you implement a custom Property Editor, consider changing the control’s behavior in accordance with the EditMask property value. However, for this purpose, the control should support editing in masked mode.

Note

The EditMask only prompts a user. It cannot prohibit saving the incorrect value (e.g., when a user does not fill all the required digits in a phone number). Use the Validation Module to configure strict rules.

See Also