GridSummaryItem Class

Represents a footer summary item.

Namespace: DevExpress.XtraGrid

Assembly: DevExpress.XtraGrid.v17.2.dll

Declaration

C#

[TypeConverter(typeof(ExpandableObjectConverter))]
public class GridSummaryItem :
    ISummaryItem

VB.NET

<TypeConverter(GetType(ExpandableObjectConverter))>
Public Class GridSummaryItem
    Implements ISummaryItem

Related API Members

The following members accept/return GridSummaryItem objects:

• GridColumn.SummaryItem
• GridMenuItemClickEventArgs.SummaryItem
• GridSummaryItemCollection.Add()
• GridSummaryItemCollection.Item[Int32]
• GridSummaryItemCollection.Item[Object]
• GroupSummarySortInfo.SummaryItem

Remarks

Grid Views allow you to display total summaries. These are aggregate function values calculated over all records within the View and displayed within the view footer under a particular column. To set up a total summary for a column, use the column’s GridColumn.SummaryItem property. This property provides access to a GridSummaryItem object that contains total summary settings. The main settings include:

• the name of the data field whose values are used for calculations (GridSummaryItem.FieldName);
• the aggregation function type (GridSummaryItem.SummaryType);
• summary value formatting (GridSummaryItem.DisplayFormat);

Additionally, GridSummaryItem objects enable you to obtain the calculated value and its formatted representation. Use the GridSummaryItem.SummaryValue and GridSummaryItem.GetDisplayText members for this purpose.

Note that the GridSummaryItem class serves as the base for the GridGroupSummaryItem class that provides settings for group summary items. The descendant inherits the declared settings (they are common for both summary types) and additionally introduces group summary specific settings.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GridSummaryItem class.

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-show-tooltips-for-summaries-displayed-in-a-group-row-e3195/CS/GroupRowSummaryHelper.cs#L22

ArrayList items = new ArrayList();
foreach (GridSummaryItem si in view.GroupSummary)
    if (si is GridGroupSummaryItem && si.SummaryType != SummaryItemType.None)

how-to-show-multiple-group-summary-items-in-the-same-group-footer-cell-in-bandedgridview-e4900/CS/Form1.cs#L39

private void AddSummaries(BandedGridView view) {
    view.GroupSummary.AddRange(new GridSummaryItem[] { new GridGroupSummaryItem() { SummaryType = SummaryItemType.Count, FieldName = "Data", ShowInGroupColumnFooter = view.Columns["Data"], DisplayFormat = "Count data = {0}" },
        new GridGroupSummaryItem() { SummaryType = SummaryItemType.Max, FieldName = "Date", ShowInGroupColumnFooter = view.Columns["Date"], DisplayFormat = "Max date = {0}" },

how-to-generate-a-live-report-based-on-gridcontrol-content-t272175/CS/WindowsFormsApplication1/GridReportExtensions/SnapReportForGridGenerator.cs#L118

static void ApplySummary(SnapListGroupInfo group, GridView grid) {
    foreach(GridSummaryItem item in grid.GroupSummary) {
        GridGroupSummaryItem summary = item as GridGroupSummaryItem;

XPO_how-to-load-unique-distinct-data-via-xpo-e1001/CS/Form1.cs#L94

this.colCompanyName.OptionsColumn.ReadOnly = true;
this.colCompanyName.Summary.AddRange(new DevExpress.XtraGrid.GridSummaryItem[] {
new DevExpress.XtraGrid.GridColumnSummaryItem(DevExpress.Data.SummaryItemType.Count)});

how-to-show-multiple-summary-values-under-the-same-column-e651/CS/CS/Form1.cs#L182

gridView1.Columns["Dummy"].UnboundType = DevExpress.Data.UnboundColumnType.Integer;
GridSummaryItem si = new GridSummaryItem(DevExpress.Data.SummaryItemType.Average, "CategoryID", "");
gridView1.Columns["Dummy"].SummaryItem.Assign(si);

VB.NET

how-to-show-tooltips-for-summaries-displayed-in-a-group-row-e3195/VB/GroupRowSummaryHelper.vb#L19

Dim items As New ArrayList()
For Each si As GridSummaryItem In view.GroupSummary
    If TypeOf si Is GridGroupSummaryItem AndAlso si.SummaryType <> SummaryItemType.None Then

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-generate-a-live-report-based-on-gridcontrol-content-t272175/VB/WindowsFormsApplication1/GridReportExtensions/SnapReportForGridGenerator.vb#L123

Private Sub ApplySummary(ByVal group As SnapListGroupInfo, ByVal grid As GridView)
    For Each item As GridSummaryItem In grid.GroupSummary
        Dim summary As GridGroupSummaryItem = TryCast(item, GridGroupSummaryItem)

XPO_how-to-load-unique-distinct-data-via-xpo-e1001/VB/Form1.vb#L93

Me.colCompanyName.OptionsColumn.ReadOnly = True
Me.colCompanyName.Summary.AddRange(New DevExpress.XtraGrid.GridSummaryItem() { New DevExpress.XtraGrid.GridColumnSummaryItem(DevExpress.Data.SummaryItemType.Count)})
Me.colCompanyName.Visible = True

how-to-show-multiple-summary-values-under-the-same-column-e651/VB/CS/Form1.vb#L171

gridView1.Columns("Dummy").UnboundType = DevExpress.Data.UnboundColumnType.Integer
Dim si As New GridSummaryItem(DevExpress.Data.SummaryItemType.Average, "CategoryID", "")
gridView1.Columns("Dummy").SummaryItem.Assign(si)

Inheritance

Object

GridSummaryItem

GridColumnSummaryItem

GridGroupSummaryItem