Skip to main content

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.v22.1.dll

NuGet Package: DevExpress.Wpf.Core


public string DisplayFormatString { get; set; }

Property Value

Type Description

A String value that is the format pattern.


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.


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:

<dxe:ButtonEdit DisplayFormatString="c" IsReadOnly="True">

Example 2:

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


Refer to the Format Specifiers topic for more information on available DisplayFormat values.

See Also