GridColumnSummary Class

A data summary item.

Namespace : DevExpress.Maui.DataGrid

Assembly : DevExpress.Maui.DataGrid.dll

NuGet Package : DevExpress.Maui.DataGrid

Declaration

public class GridColumnSummary :
    BindableObject,
    IDataGrid.IGroupSummary,
    IDataGrid.ITotalSummary

Related API Members

The following members return GridColumnSummary objects:

• CustomSummaryEventArgs.SummaryItem

Remarks

DataGridView can automatically calculate summaries for individual data columns or groups of rows. For example, it can sum values, count the number of records, detect a minimum or maximum value, etc.

The grid supports two summary types: total summaries (calculated over all rows in a column and displayed below this column) and group summaries (calculated over all rows in a group and displayed in a group row).

To create a total or group summary, add a GridColumnSummary object to the DataGridView.TotalSummaries or DataGridView.GroupSummaries collection. Use the following properties to adjust summary settings:

• GridColumnSummary.FieldName
  The field whose values are used to calculate the summary.
• GridColumnSummary.Type
  The aggregate function.
  You can use the predefined aggregate functions (Count, Min, Max, Sum or Average) or implement a custom rule (set the Type property to Custom and handle the DataGridView.CustomSummary event).
• GridColumnSummary.DisplayFormat
  The summary value format.

Example

The following example uses predefined aggregate functions (Max and Sum) and a custom rule to calculate group and total summaries for a grid that displays orders grouped by dates.

Set up the following summaries:

• A group summary to display the maximum Total value for each group of orders.

• A total summary to calculate the sum of values in the Total column.

• A custom total summary to count the number of orders with the false value in the Shipped column.

• XAML

<dxg:DataGridView x:Name="grid" ItemsSource="{Binding Orders}" 
                  CustomSummary="grid_CalculateCustomSummary">
    <!-- ... -->
    <dxg:DataGridView.GroupSummaries>
        <dxg:GridColumnSummary FieldName="Total" Type="Max"/>
    </dxg:DataGridView.GroupSummaries>

    <dxg:DataGridView.TotalSummaries>
        <dxg:GridColumnSummary FieldName="Total" Type="Sum" 
                               DisplayFormat="Total: {0:C0}"/>
        <dxg:GridColumnSummary FieldName="Shipped" Type="Custom" 
                               DisplayFormat="Not Shipped: {0}"/>
    </dxg:DataGridView.TotalSummaries>
</dxg:DataGridView>

• C#

int count;
// ...

private void grid_CustomSummary(object sender, DevExpress.Maui.DataGrid.CustomSummaryEventArgs e) {
    if (e.FieldName.ToString() == "Shipped")
        if (e.IsTotalSummary) {
            if (e.SummaryProcess == DevExpress.Maui.Core.DataSummaryProcess.Start) {
                count = 0;
            }
            if (e.SummaryProcess == DevExpress.Maui.Core.DataSummaryProcess.Calculate) {
                if (!(bool)e.Value)
                    count++;
                e.TotalValue = count;
            }
        }
}

Implements

INotifyPropertyChanged

Inheritance

System.Object BindableObject GridColumnSummary

Extension Methods

Yield<GridColumnSummary>()

YieldIfNotNull<GridColumnSummary>()

See Also

GridColumnSummary Members

DevExpress.Maui.DataGrid Namespace