SummaryItemType Enum

Lists values specifying the aggregate function types.

Namespace: DevExpress.Data

Assembly: DevExpress.Data.v18.1.dll

Declaration

C#

[TypeConverter(typeof(SummaryItemTypeConverter))]
[ResourceFinder(typeof(ResFinder))]
public enum SummaryItemType

VB.NET

<ResourceFinder(GetType(ResFinder))>
<TypeConverter(GetType(SummaryItemTypeConverter))>
Public Enum SummaryItemType

Members

Name	Description
Sum	The sum of all values in a column.
Min	The minimum value in a column.
Max	The maximum value in a column.
Count	The record count.
Average	The average value of a column.
Custom	Specifies whether calculations should be performed manually using a specially designed event.
None	Disables summary value calculation.

Related API Members

The following properties accept/return SummaryItemType values:

Library	Related API Members
WinForms Controls	GridMenuItemClickEventArgs.SummaryType
	GridSummaryItem.SummaryType
	SnapText.SummaryFunc
WPF Controls	SummaryItemBase.SummaryType
ASP.NET Web Forms Controls	ASPxSummaryItemBase.SummaryType
	CardViewSummaryItemState.SummaryType
	GridViewSummaryItemState.SummaryType
	TreeListSummaryItem.SummaryType
	VerticalGridSummaryItemState.SummaryType

Remarks

Values listed in this enumeration are used to specify the aggregate function used to calculate summary values. These values can be assigned to the properties of objects that are representing summary items in a container control.

Average and Sum summaries are only calculated for columns that contain numerical data.

Related GitHub Examples

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

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-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-bind-an-aspnet-mvc-gridview-extension-to-a-table-with-an-unknown-schema-using-custo-t602001/CS/XPCustomBindingExample/Controllers/OrdersController.cs#L56

viewModel.TotalSummary.Add(new GridViewSummaryItemState() { FieldName = "Freight", SummaryType = SummaryItemType.Average });
viewModel.TotalSummary.Add(new GridViewSummaryItemState() { FieldName = "OrderDate", SummaryType = SummaryItemType.Max });

gridview-how-to-use-a-built-in-context-menu-to-display-summaries-in-custom-binding-mode-t243497/CS/SummaryCustomDataBinding/Controllers/HomeController.cs#L40

}
SummaryItemType result;
if (Enum.TryParse<SummaryItemType>(shortCommand, out result))

how-to-show-multiple-group-summary-values-in-the-same-group-footer-cell-e3607/CS/MultiGroupSummary/ToolTipHelper.cs#L44

}
if (summaryItem.SummaryType == SummaryItemType.None) {
    return;

how-to-convert-and-then-print-an-gridview-extension-by-using-the-xtrareport-e4755/CS/E4755/Models/MVCxGridViewState.cs#L107

}
public SummaryItemType SummaryType {
    get;

VB.NET

how-to-bind-an-aspnet-mvc-gridview-extension-to-a-table-with-an-unknown-schema-using-custo-t602001/VB/XPCustomBindingExample/Controllers/OrdersController.vb#L59

viewModel.TotalSummary.Add(New GridViewSummaryItemState() With {.FieldName = "Freight", .SummaryType = SummaryItemType.Average})
viewModel.TotalSummary.Add(New GridViewSummaryItemState() With {.FieldName = "OrderDate", .SummaryType = SummaryItemType.Max})

gridview-how-to-use-a-built-in-context-menu-to-display-summaries-in-custom-binding-mode-t243497/VB/SummaryCustomDataBinding/Controllers/HomeController.vb#L38

End If
Dim result As SummaryItemType
If System.Enum.TryParse(Of SummaryItemType)(shortCommand, result) Then

how-to-convert-and-then-print-an-gridview-extension-by-using-the-xtrareport-e4755/VB/E4755/Models/ReportHelperMVC.vb#L157

End Function
Private Function GetSummaryFunc(ByVal summaryItemType As SummaryItemType) As SummaryFunc
    Select Case summaryItemType

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-show-multiple-group-summary-values-in-the-same-group-footer-cell-e3607/VB/MultiGroupSummary/ToolTipHelper.vb#L44

End If
If summaryItem.SummaryType = SummaryItemType.None Then
    Return