SummaryItemBase.DisplayFormat Property

Gets or sets the pattern used to format the summary value. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v19.2.Core.dll

Declaration

C#

public string DisplayFormat { get; set; }

VB.NET

Public Property DisplayFormat As String

Property Value

Type	Description
String	A String value that specifies the pattern used to format the summary value.

Remarks

Use the DisplayFormat property to format the summary value and add any text to its textual representation. The general pattern is shown below:

[custom static text] {0:[format specifier][precision specifier]} [custom static text]

• {0} - the summary value’s placeholder;
• Format specifier - specifies the formating type (currency, scientific, etc);
• Precision specifier - specifies the number of characters displayed after the decimal point.

Example

To display currency values, set the DisplayFormat property to ‘Total: {0:c2}‘. If the summary value is 100, its formatted equivalent will be ‘Total: $100.00‘.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DisplayFormat 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-apply-sorting-by-summary-along-with-sorting-by-the-column-e4611/CS/GroupSorting/MainWindow.xaml#L34

                     SummaryType="Sum"
                     DisplayFormat="N"/>
<dxg:GridSummaryItem FieldName="Amount"

how-to-align-a-group-summary-to-the-left-within-a-group-row-e2400/CS/LeftAlignSummary/Window1.xaml#L22

<dxg:GridControl.GroupSummary>
    <dxg:GridSummaryItem SummaryType="Count" DisplayFormat="({0})" />
    <dxg:GridSummaryItem SummaryType="Sum" FieldName="Value" DisplayFormat="Sum: {0}" />

how-to-display-total-summaries-e1636/CS/DXGrid_DisplayTotals/Window1.xaml#L10

<dxg:GridSummaryItem FieldName="UserName" SummaryType="Count"
                      DisplayFormat="Total Users: {0}"/>
<dxg:GridSummaryItem FieldName="Age" SummaryType="Min"/>

how-to-create-the-print-page-header-and-footer-when-exporting-the-gridcontrol-e2608/CS/GridPrint/Window1.xaml#L43

<dxg:GridControl.GroupSummary>
    <dxg:GridSummaryItem DisplayFormat="Price: {0:c}"
                         FieldName="Price"

how-to-bind-to-infinitesource/CS/MainWindow.xaml#L31

    <dxg:GridSummaryItem SummaryType="Count" Alignment="Right"/>
    <dxg:GridSummaryItem SummaryType="Max" FieldName="Created" DisplayFormat="{}Last created: {0}" Alignment="Right"/>
</dxg:GridControl.TotalSummary>

VB.NET

how-to-convert-and-then-print-gridcontrol-by-using-xtrareport-e4658/VB/DXGridSample/ReportHelper.vb#L53

label.Summary = New XRSummary() With {.Running = SummaryRunning.Report}
label.Summary.FormatString = item.DisplayFormat
label.Summary.Func = GetSummaryFunc(item.SummaryType)