MaskProperties.UseMaskAsDisplayFormat Property

Gets or sets whether display values are still formatted using the mask when the editor is not focused.

Namespace: DevExpress.XtraEditors.Mask

Assembly: DevExpress.XtraEditors.v19.2.dll

Declaration

C#

public virtual bool UseMaskAsDisplayFormat { get; set; }

VB.NET

Public Overridable Property UseMaskAsDisplayFormat As Boolean

Property Value

Type	Default	Description
Boolean	**false**	true if the mask settings are used to format display values when the editor is not focused; false if the RepositoryItem.DisplayFormat object’s settings are used instead.

Remarks

You can set the UseMaskAsDisplayFormat property to true to use the current mask settings to form the editor’s display text when the editor is not focused. As a result the editor’s text in edit and display mode will be identical.

If this property is set to false the editor’s display text is formed according to the settings provided by the RepositoryItem.DisplayFormat property.

If the editor’s MaskProperties.MaskType property is set to MaskType.None the UseMaskAsDisplayFormat property is ignored. In this case, the RepositoryItem.DisplayFormat property’s settings are used to format display values.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the UseMaskAsDisplayFormat 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#

mvvm-best-practices-t228317/CS/POCODependencies/SimpleDependenciesUserControl.cs#L21

editor1.Properties.Mask.EditMask = "n0";
editor1.Properties.Mask.UseMaskAsDisplayFormat = true;

how-to-display-custom-properties-for-the-layoutcontrolitem-in-the-customization-form-e1571/CS/S132265/MyLayoutControlItemPropertyWrapper.cs#L94

get {
    if (Editor != null) return Editor.Properties.Mask.UseMaskAsDisplayFormat;
    else return false;

how-to-customize-separators-of-an-edit-mask-e487/CS/CustomCulture/Form1.cs#L31

textEdit1.Properties.Mask.MaskType = DevExpress.XtraEditors.Mask.MaskType.Numeric;
textEdit1.Properties.Mask.UseMaskAsDisplayFormat = true;
textEdit1.EditValue = 1234.56789m;

XAF_how-to-implement-a-property-editor-using-a-control-from-the-xtraeditors-library-e232/CS/E232.Module.Win/MyDecimalCalcEditPropertyEditor.cs#L25

    ((RepositoryItemCalcEdit)item).Mask.EditMask = "C";
    ((RepositoryItemCalcEdit)item).Mask.UseMaskAsDisplayFormat = true;
}

how-to-dynamically-provide-an-in-place-editor-for-the-propertygrid-e475/CS/WindowsFormsApplication149/Form1.cs#L28

ri.Mask.EditMask = @"(\(\d\d\d\))?\d{1,3}-\d\d-\d\d";
ri.Mask.UseMaskAsDisplayFormat = true;
propertyGridControl1.RepositoryItems.Add(ri);

VB.NET

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

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

how-to-customize-separators-of-an-edit-mask-e487/VB/CustomCulture/Form1.vb#L33

textEdit1.Properties.Mask.MaskType = DevExpress.XtraEditors.Mask.MaskType.Numeric
textEdit1.Properties.Mask.UseMaskAsDisplayFormat = True
textEdit1.EditValue = 1234.56789D

XAF_how-to-implement-a-property-editor-using-a-control-from-the-xtraeditors-library-e232/VB/E232.Module.Win/MyDecimalCalcEditPropertyEditor.vb#L27

    CType(item, RepositoryItemCalcEdit).Mask.EditMask = "C"
    CType(item, RepositoryItemCalcEdit).Mask.UseMaskAsDisplayFormat = True
End Sub

how-to-dynamically-provide-an-in-place-editor-for-the-propertygrid-e475/VB/WindowsFormsApplication149/Form1.vb#L26

ri.Mask.EditMask = "(\(\d\d\d\))?\d{1,3}-\d\d-\d\d"
ri.Mask.UseMaskAsDisplayFormat = True
propertyGridControl1.RepositoryItems.Add(ri)

how-to-configure-rating-control-t190685/VB/dxSample/MainForm.vb#L80

riTextEdit.Mask.EditMask = "c"
riTextEdit.Mask.UseMaskAsDisplayFormat = True
AddHandler riTextEdit.CustomDisplayText, AddressOf riTextEdit_CustomDisplayText