GridColumnSummaryItem Class
A column’s total summary item.
Namespace: DevExpress.XtraGrid
Assembly: DevExpress.XtraGrid.v24.1.dll
NuGet Packages: DevExpress.Win.Grid, DevExpress.Win.Navigation
Declaration
Related API Members
The following members return GridColumnSummaryItem objects:
Remarks
Enable the View’s OptionsView.ShowFooter property to display the total summary footer.
You can display multiple total summaries for a column. To add summaries, use the GridColumn.Summary collection. This collection’s elements are GridColumnSummaryItem objects.
The GridColumnSummaryItem objects have the following properties:
- GridSummaryItem.FieldName specifies a summary’s field name.
- GridSummaryItem.SummaryType specifies a summary’s type. For example, Sum, Min, Max, Count, Custom etc.
- GridSummaryItem.DisplayFormat specifies a summary’s display format.
- GridSummaryItem.Tag allows you to associate data with the summary item.
The image below shows total summaries in a column’s footer.
Example
The example demonstrates how to add a total summary and set its summary type, field name and display format. Note that a summary is added for the Units In Stock column and it will be shown in this column. However, the summary will be calculated against a Unit Price field name.
gridView1.OptionsView.ShowFooter = true;
GridColumnSummaryItem item = colUnitsInStock1.Summary.Add();
item.SummaryType = DevExpress.Data.SummaryItemType.Average;
item.FieldName = "UnitPrice";
item.DisplayFormat = "Average Unit Price = {0:c2}";