BaseEdit.DisplayFormatString Property

Gets or sets the pattern used to format the editor's value for display purposes. This is a dependency property.

Namespace: DevExpress.Xpf.Editors

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

Declaration

C#

public string DisplayFormatString { get; set; }

VB.NET

Public Property DisplayFormatString As String

Property Value

Type	Description
String	A String value that is the format pattern.

Remarks

Use the DisplayFormatString property to format the editor's value and add any text to its textual representation. The formatted text is displayed if the editor's value is not currently edited (e.g. the editor is not focused or it is read-only).

For example, to display currency values, set the DisplayFormatString property to 'c2'. If the editor's value is 99.9, its formatted equivalent will be $99.90.

NOTE

An editor's value is formatted using string.Format("{0:DisplayFormat}, BaseEdit.EditValue). The specified display format should match the value's type (Example 1). Otherwise, it is ignored and is not applied (Example 2).

Example 1:

XAML

<dxe:ButtonEdit DisplayFormatString="c" IsReadOnly="True">
            <dxe:ButtonEdit.EditValue>
                <sys:Double>123</sys:Double>
            </dxe:ButtonEdit.EditValue>
        </dxe:ButtonEdit>

Example 2:

XAML

<dxe:ButtonEdit DisplayFormatString="c" IsReadOnly="True" EditValue="123">
        </dxe:ButtonEdit>

Implements

DevExpress.Xpf.Editors.IBaseEdit.DisplayFormatString