GridSummaryItem.DisplayFormat Property

Gets or sets the display format rule for the GridSummaryItem value. An empty string to apply the default format rule.

Namespace: DevExpress.XtraGrid

Assembly: DevExpress.XtraGrid.v18.2.dll

Declaration

C#

[DefaultValue("")]
[XtraSerializableProperty(100)]
public string DisplayFormat { get; set; }

VB.NET

<DefaultValue("")>
<XtraSerializableProperty(100)>
Public Property DisplayFormat As String

Property Value

Type	Default	Description
String	String.Empty	A string that specifies the display format rule for the GridSummaryItem.

Remarks

The display format rule syntax is:

<custom text>{0<:format specifier<precision specifier>>}<custom text>

• custom text - any custom string displayed before and after the summary value.
• ‘{0}’ - the placeholder for the summary value.
• format specifier - specifies the summary value format.
• precision specifier - the number of digits after the decimal point.

The Create total and group summaries demo illustrates how to apply display format rules to total and group summary items.

C#

gridView.OptionsView.ShowFooter = true;
gridView.Columns["Mark"].Group();

// Creating total and group summaries
GridColumn column = gridView.Columns["Length"];
column.SummaryItem.SummaryType = SummaryItemType.Sum;
// format the total summary
column.SummaryItem.DisplayFormat = "Total: {0:n3}";
// group summary
gridView.GroupSummary.Add(SummaryItemType.Count, "Mark");

gridView.GroupSummary.Add(new GridGroupSummaryItem()
{
    FieldName = "Length",
    SummaryType = SummaryItemType.Sum,
    DisplayFormat = "Sum: {0:n5}",
    ShowInGroupColumnFooter = gridView.Columns["Length"]
});

VB.NET

gridView.OptionsView.ShowFooter = True
gridView.Columns("Mark").Group()

' Creating total and group summaries
Dim column As GridColumn = gridView.Columns("Length")
column.SummaryItem.SummaryType = SummaryItemType.Sum
' format the total summary
column.SummaryItem.DisplayFormat = "Total: {0:n3}"
' group summary
gridView.GroupSummary.Add(SummaryItemType.Count, "Mark")

gridView.GroupSummary.Add(New GridGroupSummaryItem() With {.FieldName = "Length", .SummaryType = SummaryItemType.Sum, .DisplayFormat = "Sum: {0:n5}", .ShowInGroupColumnFooter = gridView.Columns("Length")})

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-generate-a-live-report-based-on-gridcontrol-content-t272175/CS/WindowsFormsApplication1/GridReportExtensions/SnapReportForGridGenerator.cs#L153

static void BuildSummaryTemplate(SnapDocument template, TableCell box, GridSummaryItem source, SummaryRunning running) {
    MatchCollection formatFields = formatFinder.Matches(source.DisplayFormat);
    int k = 0;

how-to-align-summary-values-displayed-in-a-group-row-to-the-corresponding-columns-e773/CS/WindowsApplication3/Form1.cs#L48

item.SummaryType = DevExpress.Data.SummaryItemType.Sum;
item.DisplayFormat = "Sum {0:n0}";
item.ShowInGroupColumnFooter = gridView1.Columns[item.FieldName];

how-to-hide-footers-based-on-the-number-of-rows-e4278/CS/HideableGroupRowFooters/Form1.cs#L83

item1.FieldName = "NumOfSmth";
item1.DisplayFormat = "{0:f3}";
item1.SummaryType = DevExpress.Data.SummaryItemType.Average;

how-to-provide-the-capability-to-hide-group-footer-rows-at-a-specific-group-level-e2429/CS/HideableGroupRowFooters/Form1.cs#L66

item1.FieldName = "NumOfSmth";
item1.DisplayFormat = "{0:f3}";
item1.SummaryType = DevExpress.Data.SummaryItemType.Average;

VB.NET

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

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)

how-to-hide-footers-based-on-the-number-of-rows-e4278/VB/HideableGroupRowFooters/Form1.vb#L78

item1.FieldName = "NumOfSmth"
item1.DisplayFormat = "{0:f3}"
item1.SummaryType = DevExpress.Data.SummaryItemType.Average

how-to-provide-the-capability-to-hide-group-footer-rows-at-a-specific-group-level-e2429/VB/HideableGroupRowFooters/Form1.vb#L60

item1.FieldName = "NumOfSmth"
item1.DisplayFormat = "{0:f3}"
item1.SummaryType = DevExpress.Data.SummaryItemType.Average