Total Summary

  • 3 minutes to read

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

cdTotalSummary

Total summaries are represented by the ASPxSummaryItem objects. ASPxGridView stores its total summaries within the ASPxGridView.TotalSummary collection. To manage this collection at design time, you can use the Edit Form as shown above.

The ASPxSummaryItem.ShowInColumn property allows you to specify which column should display a summary value in the footer cell. If the ShowInColumn property is not specified, the summary is displayed in a column specified via the ASPxSummaryItemBase.FieldName property.

To obtain a total summary value and its text representation, use the ASPxGridView.GetTotalSummaryValue and ASPxSummaryItem.GetTotalFooterDisplayText methods respectively.

Example: Creating Total and Group Summaries in Markup

The code sample below demonstrates how you can specify group and total summaries. To specify the group summary items location, the ASPxSummaryItem.ShowInColumn and ASPxSummaryItem.ShowInGroupFooterColumn properties are used.

Note that summary item four is not displayed because the 'OrderDate' column, where the item should be displayed, does not exist (the grid is grouped by the 'OrderDate' field). Summary item five is not displayed because the 'Total' group row, where the item should be displayed, does not exist (the grid is not grouped by the 'Total' field)

The image below shows the result.

SummaryItem

<dx:ASPxGridView ID="grid" ...>
     ...
     <TotalSummary>
          <dx:ASPxSummaryItem FieldName="Total" SummaryType="Min" />
          <dx:ASPxSummaryItem FieldName="Total" SummaryType="Max" />
          <dx:ASPxSummaryItem FieldName="Total" SummaryType="Sum" />
     </TotalSummary>

     <GroupSummary>
          <%-- Group Summary Item 1 --%>
          <dx:ASPxSummaryItem FieldName="Country" ShowInColumn="Country" SummaryType="Count" />
          <%-- Group Summary Item 2 --%>
          <dx:ASPxSummaryItem FieldName="Quantity" ShowInGroupFooterColumn="UnitPrice" SummaryType="Sum" />
          <%-- Group Summary Item 3 --%>
          <dx:ASPxSummaryItem FieldName="Total" ShowInColumn="ProductName" ShowInGroupFooterColumn="Quantity" SummaryType="Sum" />
          <%-- Group Summary Item 4 --%>
          <dx:ASPxSummaryItem FieldName="Quantity" SummaryType="Sum" ShowInGroupFooterColumn="OrderDate" />
          <%-- Group Summary Item 5 --%>
          <dx:ASPxSummaryItem FieldName="Total" SummaryType="Sum" ShowInColumn="Total" />
     </GroupSummary>
     <Settings ShowGroupPanel="True" ShowFooter="True" ShowGroupFooter="VisibleIfExpanded"></Settings>
</dx:ASPxGridView>

Example: Creating Total Summaries in Code

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

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);
}
See Also