ASPxGridView.TotalSummary Property

Provides access to total summary items.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v19.1.dll

Declaration

C#

[DefaultValue(null)]
public ASPxSummaryItemCollection TotalSummary { get; }

VB.NET

<DefaultValue(Nothing)>
Public ReadOnly Property TotalSummary As ASPxSummaryItemCollection

Property Value

Type	Default	Description
ASPxSummaryItemCollection	*null*	An ASPxSummaryItemCollection object that is the collection of summary items.

Remarks

Total summaries are displayed within footer cells provided that the ASPxGridViewSettings.ShowFooter option is set to true. The total summary represents a value of an aggregate function calculated over all data rows displayed within the ASPxGridView.

Note

In server mode, a summary cannot be calculated for unbound columns whose values are calculated via events (see ASPxGridView.CustomUnboundColumnData). Only columns with unbound expressions (see GridViewDataColumn.UnboundExpression) support summary calculation.

To learn more, see Data Summaries.

Example

This example shows how to calculate the average budget and display it within the ASPxGridView’s footer:

C#

protected void Page_Load(object sender, EventArgs e) {
     ASPxSummaryItem totalSummary = new ASPxSummaryItem();
     totalSummary.FieldName = "Budget";
     totalSummary.ShowInColumn = "Budget";
     totalSummary.SummaryType = SummaryItemType.Average;
     ASPxGridView1.TotalSummary.Add(totalSummary);
}

VB.NET

Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
     Dim totalSummary As ASPxSummaryItem = New ASPxSummaryItem()
     totalSummary.FieldName = "Budget"
     totalSummary.ShowInColumn = "Budget"
     totalSummary.SummaryType = SummaryItemType.Average
     ASPxGridView1.TotalSummary.Add(totalSummary)
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the TotalSummary 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-calculate-the-total-summary-value-based-on-values-of-other-summaries-e1429/CS/Default.aspx.cs#L15

protected void ASPxGridView1_CustomSummaryCalculate(object sender, DevExpress.Data.CustomSummaryEventArgs e) {
    ASPxSummaryItem incomeSummary = (sender as ASPxGridView).TotalSummary["Income"];
    ASPxSummaryItem expenseSummary = (sender as ASPxGridView).TotalSummary["Expense"];

how-to-display-a-total-summary-within-the-column-header-e1320/CS/CS/Default.aspx.cs#L25

GridViewDataColumn col = grid.Columns["UnitsInStock"] as GridViewDataColumn;
ASPxSummaryItem summary = grid.TotalSummary["UnitsInStock", DevExpress.Data.SummaryItemType.Sum];
string text = summary.GetTotalFooterDisplayText(col, grid.GetTotalSummaryValue(summary));

total-summary-as-hyperlink-e1262/CS/WebApplication11/Default.aspx.cs#L25

{
    ASPxSummaryItem item = ((ASPxGridView)sender).TotalSummary["UnitPrice"] as ASPxSummaryItem;
    object val = ASPxGridView1.GetTotalSummaryValue(item);

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

TotalSummary = new System.Collections.ObjectModel.Collection<MVCxSummaryItemState>();
foreach (ASPxSummaryItem item in gridView.TotalSummary) {
    TotalSummary.Add(new MVCxSummaryItemState(item));

VB.NET

how-to-calculate-the-total-summary-value-based-on-values-of-other-summaries-e1429/VB/Default.aspx.vb#L18

Protected Sub ASPxGridView1_CustomSummaryCalculate(ByVal sender As Object, ByVal e As DevExpress.Data.CustomSummaryEventArgs)
    Dim incomeSummary As ASPxSummaryItem = (TryCast(sender, ASPxGridView)).TotalSummary("Income")
    Dim expenseSummary As ASPxSummaryItem = (TryCast(sender, ASPxGridView)).TotalSummary("Expense")

how-to-display-a-total-summary-within-the-column-header-e1320/VB/CS/Default.aspx.vb#L23

Dim col As GridViewDataColumn = TryCast(grid.Columns("UnitsInStock"), GridViewDataColumn)
Dim summary As ASPxSummaryItem = grid.TotalSummary("UnitsInStock", DevExpress.Data.SummaryItemType.Sum)
Dim text As String = summary.GetTotalFooterDisplayText(col, grid.GetTotalSummaryValue(summary))

total-summary-as-hyperlink-e1262/VB/WebApplication11/Default.aspx.vb#L23

Protected Sub ASPxGridView1_DataBound(ByVal sender As Object, ByVal e As EventArgs)
    Dim item As ASPxSummaryItem = TryCast(DirectCast(sender, ASPxGridView).TotalSummary("UnitPrice"), ASPxSummaryItem)
    Dim val As Object = ASPxGridView1.GetTotalSummaryValue(item)

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

TotalSummary = New System.Collections.ObjectModel.Collection(Of MVCxSummaryItemState)()
For Each item As ASPxSummaryItem In gridView.TotalSummary
    TotalSummary.Add(New MVCxSummaryItemState(item))