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.v19.1.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>

Note

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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DisplayFormatString 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-format-display-values-via-standard-format-specifiers-e3398/VB/Standard Specifiers Sample/MainWindow.xaml#L19

<Label Content="Currency:" VerticalAlignment="Center" Margin="0,4"></Label>
<dxe:SpinEdit Name="spinEdit1" DisplayFormatString="c2" Margin="1,-1,0,1" Grid.Column="1" VerticalAlignment="Center">
    <dxe:SpinEdit.EditValue>

how-to-format-display-values-via-composite-formatting-e3399/VB/Composite Formatting Sample/MainWindow.xaml#L19

<Label Content="Order:" Grid.Row="0" Grid.Column="0" VerticalAlignment="Center"></Label>
<dxe:TextEdit Text="00075" DisplayFormatString="ID {0}" Grid.Row="0" Grid.Column="1" VerticalAlignment="Center" />
<Label Content="In Stock:" Grid.Row="1" Grid.Column="0" VerticalAlignment="Center"></Label>

dxscheduler-getting-started-create-a-custom-edit-appointment-form-e2499/CS/SchedulerCustomAppointmentForm/CustomAppointmentForm.xaml#L55

AllowDefaultButton="False"
MaskType="DateTime" DisplayFormatString="{Binding TimeEditMask}"
Mask="{Binding TimeEditMask}"

how-to-invoke-the-default-appointment-recurrence-dialog-from-a-custom-edit-appointment-form-e3796/CS/WpfApplication1/CustomAppointmentForm.xaml#L55

AllowDefaultButton="False"
MaskType="DateTime" DisplayFormatString="{Binding TimeEditMask}"
Mask="{Binding TimeEditMask}"

how-to-create-a-custom-edit-appointment-form-using-the-mvvm-pattern-t103885/CS/MVVMSchedulerApplication/HospitalAppointmentForm.xaml#L58

              EditValue ="{Binding DisplayStartDate, UpdateSourceTrigger=PropertyChanged, Mode=TwoWay}"/>
<dxe:TextEdit x:Name="edtStartTime" MinWidth="150" MaskType="DateTime" DisplayFormatString="{Binding TimeEditMask}"
              Mask="{Binding TimeEditMask}" Grid.Row="0" Grid.Column="1" Margin="6,0,0,0"