MaskProperties.PlaceHolder Property

For the Simple, Regular and RegEx mask types this property gets or sets the character used as the placeholder in a masked editor.

Namespace: DevExpress.XtraEditors.Mask

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

C#

public virtual char PlaceHolder { get; set; }

VB.NET

Public Overridable Property PlaceHolder As Char

Property Value

Type	Default	Description
Char	'_'	The character used as the placeholder in a masked editor.

Remarks

Use the PlaceHolder property to specify the character which is the placeholder.

Placeholders are displayed in the MaskType.Simple, MaskType.Regular and MaskType.RegEx mask modes.

For the MaskType.RegEx mask mode placeholders can be hidden by setting the MaskProperties.ShowPlaceHolders property to false.

The following images show empty masked editors with different placeholders. The mask expression is ‘[phone]’. The mask type is MaskType.Simple.

Placeholder	Image
‘_’
‘*’

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the PlaceHolder 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-display-custom-properties-for-the-layoutcontrolitem-in-the-customization-form-e1571/CS/S132265/MyLayoutControlItemPropertyWrapper.cs#L64

get {
    if (Editor != null) return Editor.Properties.Mask.PlaceHolder;
    else return '\0';

VB.NET

how-to-display-custom-properties-for-the-layoutcontrolitem-in-the-customization-form-e1571/VB/S132265/MyLayoutControlItemPropertyWrapper.vb#L100

If Editor IsNot Nothing Then
    Return Editor.Properties.Mask.PlaceHolder
Else