GridSummaryItem.DisplayFormat Property
Gets or sets the summary value formatting.
Namespace: DevExpress.XtraGrid
Assembly:
DevExpress.XtraGrid.v17.2.dll
Declaration
[DefaultValue("")]
[XtraSerializableProperty(100)]
public string DisplayFormat { get; set; }
<DefaultValue("")>
<XtraSerializableProperty(100)>
Public Property DisplayFormat As String
Property Value
| Type |
Default |
Description |
| String |
String.Empty
|
A string specifying the summary value’s display format. An empty string to display the summary value using default formatting.
|
The DisplayFormat property can be used to apply formatting to the summary value and add any static text to its textual representation. The general pattern for setting the DisplayFormat property value is the following:
<custom static text>{0<:format specifier<precision specifier>>}<custom static text>
Here, the ‘{0}‘ character sequence is the summary value’s placeholder. The format specifier sets the formatting type to be applied (currency, scientific, etc). The precision specifier sets the number of characters to be displayed after the decimal point.
For instance, if displaying currency values within a column, you can set the DisplayFormat property to ‘Total: {0:c2}‘. If the summary value is 123, the formatted summary value representation will be the ‘Total: $123.00‘.
Please refer to the Format Specifiers topic for details on using format specifiers.
Note: setting the DisplayFormat property to an empty string applies default summary value formatting. Please refer to the GridSummaryItem.GetDisplayFormatByType method description for details.
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.
how-to-generate-a-live-report-based-on-gridcontrol-content-t272175/VB/WindowsFormsApplication1/GridReportExtensions/SnapReportForGridGenerator.vb#L159
Private Sub BuildSummaryTemplate(ByVal template As SnapDocument, ByVal box As TableCell, ByVal source As GridSummaryItem, ByVal running As SummaryRunning)
Dim formatFields As MatchCollection = formatFinder.Matches(source.DisplayFormat)
Dim k As Integer = 0
a-better-way-to-implement-a-frequently-used-custom-summary-weighted-averages-example-e892/VB/Form1.vb#L122
Me.colUnitPrice.Name = "colUnitPrice"
Me.colUnitPrice.SummaryItem.DisplayFormat = "W Avg: {0:c2}"
Me.colUnitPrice.SummaryItem.SummaryType = DevExpress.Data.SummaryItemType.Custom
how-to-immediately-update-gridview-states-after-a-cell-value-is-changed-e4300/VB/WindowsFormsApplication1/Form1.vb#L45
gridView1.Columns(columnName).SummaryItem.SummaryType = DevExpress.Data.SummaryItemType.Custom
gridView1.Columns(columnName).SummaryItem.DisplayFormat = "Custom Sum = {0}"
gridView1.Columns(columnName).ColumnEdit = reTextEdit
how-to-show-multiple-group-summary-items-in-the-same-group-footer-cell-in-bandedgridview-e4900/VB/Form1.vb#L41
Private Sub AddSummaries(ByVal view As BandedGridView)
view.GroupSummary.AddRange(New GridSummaryItem() { New GridGroupSummaryItem() With {.SummaryType = SummaryItemType.Count, .FieldName = "Data", .ShowInGroupColumnFooter = view.Columns("Data"), .DisplayFormat = "Count data = {0}"}, New GridGroupSummaryItem() With {.SummaryType = SummaryItemType.Max, .FieldName = "Date", .ShowInGroupColumnFooter = view.Columns("Date"), .DisplayFormat = "Max date = {0}"}, New GridGroupSummaryItem() With {.SummaryType = SummaryItemType.Min, .FieldName = "Date", .ShowInGroupColumnFooter = view.Columns("Date"), .DisplayFormat = "Min date = {0}"}, New GridGroupSummaryItem() With {.SummaryType = SummaryItemType.Count, .FieldName = "Date", .ShowInGroupColumnFooter = view.Columns("Date"), .DisplayFormat = "Count date = {0}"}, New GridGroupSummaryItem() With {.SummaryType = SummaryItemType.Average, .FieldName = "Int", .ShowInGroupColumnFooter = view.Columns("Int"), .DisplayFormat = "Avg int = {0}"}, New GridGroupSummaryItem() With {.SummaryType = SummaryItemType.Sum, .FieldName = "Int", .ShowInGroupColumnFooter = view.Columns("Int"), .DisplayFormat = "Sum int = {0}"}, New GridGroupSummaryItem() With {.SummaryType = SummaryItemType.Count, .FieldName = "Int", .ShowInGroupColumnFooter = view.Columns("Int"), .DisplayFormat = "Count int = {0}"}, New GridGroupSummaryItem() With {.SummaryType = SummaryItemType.Count, .FieldName = "String", .ShowInGroupColumnFooter = view.Columns("String"), .DisplayFormat = "Count string = {0}"} })
End Sub
how-to-align-summary-values-displayed-in-a-group-row-to-the-corresponding-columns-e773/VB/WindowsApplication3/Form1.vb#L52
item.SummaryType = DevExpress.Data.SummaryItemType.Sum
item.DisplayFormat = "Sum {0:n0}"
item.ShowInGroupColumnFooter = gridView1.Columns(item.FieldName)
See Also