SummaryItemBase.SummaryType Property

Gets or sets the aggregate function type. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v20.2.Core.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Grid.Core, DevExpress.Wpf.Grid.Core

Declaration

C#

public SummaryItemType SummaryType { get; set; }

VB.NET

Public Property SummaryType As SummaryItemType

Property Value

Type	Description
SummaryItemType	A SummaryItemType enumeration value that specifies the aggregate function type.

Available values:

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.

Remarks

There are five predefined aggregate functions. These are: Sum, Min, Max, Average and Count. To implement your own aggregate function, set the SummaryType property to SummaryItemType.Custom, and handle the GridControl.CustomSummary event.

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

Example

The following example demonstrates how to use custom summaries to count the total number of empty cells in the specified grid column.

View Example

Window1.xaml

<Window x:Class="CustomSummary_EmptyCells.Window1"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:dx="http://schemas.devexpress.com/winfx/2008/xaml/core"
    xmlns:dxg="http://schemas.devexpress.com/winfx/2008/xaml/grid"
    Title="Window1" Height="350" Width="450" >
    <Grid>
        <dxg:GridControl x:Name="grid" CustomSummary="grid_CustomSummary" GroupCount="1">
            <dxg:GridControl.SortInfo>
                <dxg:GridSortInfo FieldName="Text" />
            </dxg:GridControl.SortInfo>
            <dxg:GridControl.Columns>
                <dxg:GridColumn FieldName="Text" />
                <dxg:GridColumn FieldName="Number" />
            </dxg:GridControl.Columns>
            <dxg:GridControl.View>
                <dxg:TableView x:Name="view" AutoWidth="True" 
                               NavigationStyle="Cell" ShowTotalSummary="True"/>
            </dxg:GridControl.View>
            <dxg:GridControl.TotalSummary>
                <dxg:GridSummaryItem FieldName="Number" SummaryType="Custom" 
                                     DisplayFormat="Total empty cells count: {0}"/>
            </dxg:GridControl.TotalSummary>
            <dxg:GridControl.GroupSummary>
                <dxg:GridSummaryItem FieldName="Number" SummaryType="Custom" 
                                     DisplayFormat="Group empty cells count: {0}"/>
            </dxg:GridControl.GroupSummary>
        </dxg:GridControl>
    </Grid>
</Window>

Window1.xaml.cs

using System.Windows;
using System.Collections.Generic;
using DevExpress.Data;
using DevExpress.Xpf.Data;
using DevExpress.Xpf.Grid;
// ...

namespace CustomSummary_EmptyCells {
    /// <summary>
    /// Interaction logic for Window1.xaml
    /// </summary>
    public partial class Window1 : Window {
        List<TestData> list;
        Dictionary<int, bool> selectedValues = new Dictionary<int, bool>();

        public Window1() {
            InitializeComponent();
            list = new List<TestData>();
            for (int i = 0; i < 100; i++) {
                list.Add(new TestData() { Text = "group " + i % 10, Number = i });
                if (i % 3 == 0)
                    list[i].Number = null;
            }
            grid.ItemsSource = list;
        }

        int emptyCellsTotalCount = 0;
        int emptyCellsGroupCount = 0;

        void grid_CustomSummary(object sender, CustomSummaryEventArgs e) {
            if (((GridSummaryItem)e.Item).FieldName != "Number")
                return;
            if (e.IsTotalSummary) {
                if (e.SummaryProcess == CustomSummaryProcess.Start) {
                    emptyCellsTotalCount = 0;
                }
                if (e.SummaryProcess == CustomSummaryProcess.Calculate) {
                    int? val = (int?)e.FieldValue;
                    if (!val.HasValue)
                        emptyCellsTotalCount++;
                    e.TotalValue = emptyCellsTotalCount;
                }
            }
            if (e.IsGroupSummary) {
                if (e.SummaryProcess == CustomSummaryProcess.Start) {
                    emptyCellsGroupCount = 0;
                }
                if (e.SummaryProcess == CustomSummaryProcess.Calculate) {
                    int? val = (int?)e.FieldValue;
                    if (!val.HasValue)
                        emptyCellsGroupCount++;
                    e.TotalValue = emptyCellsGroupCount;
                }
            }
        }

        public class TestData {
            public string Text { get; set; }
            public int? Number { get; set; }
        }
    }
}

Window1.xaml.vb

Imports Microsoft.VisualBasic
Imports System.Windows
Imports System.Collections.Generic
Imports DevExpress.Data
Imports DevExpress.Xpf.Data
Imports DevExpress.Xpf.Grid
' ...

Namespace CustomSummary_EmptyCells
    ''' <summary>
    ''' Interaction logic for Window1.xaml
    ''' </summary>
    Partial Public Class Window1
        Inherits Window
        Private list As List(Of TestData)
        Private selectedValues As New Dictionary(Of Integer, Boolean)()

        Public Sub New()
            InitializeComponent()
            list = New List(Of TestData)()
            For i As Integer = 0 To 99
                list.Add(New TestData() With {.Text = "group " & i Mod 10, .Number = i})
                If i Mod 3 = 0 Then
                    list(i).Number = Nothing
                End If
            Next i
            grid.ItemsSource = list
        End Sub

        Private emptyCellsTotalCount As Integer = 0
        Private emptyCellsGroupCount As Integer = 0

        Private Sub grid_CustomSummary(ByVal sender As Object, ByVal e As CustomSummaryEventArgs)
            If (CType(e.Item, GridSummaryItem)).FieldName <> "Number" Then
                Return
            End If
            If e.IsTotalSummary Then
                If e.SummaryProcess = CustomSummaryProcess.Start Then
                    emptyCellsTotalCount = 0
                End If
                If e.SummaryProcess = CustomSummaryProcess.Calculate Then
                    Dim val? As Integer = CType(e.FieldValue, Integer?)
                    If (Not val.HasValue) Then
                        emptyCellsTotalCount += 1
                    End If
                    e.TotalValue = emptyCellsTotalCount
                End If
            End If
            If e.IsGroupSummary Then
                If e.SummaryProcess = CustomSummaryProcess.Start Then
                    emptyCellsGroupCount = 0
                End If
                If e.SummaryProcess = CustomSummaryProcess.Calculate Then
                    Dim val? As Integer = CType(e.FieldValue, Integer?)
                    If (Not val.HasValue) Then
                        emptyCellsGroupCount += 1
                    End If
                    e.TotalValue = emptyCellsGroupCount
                End If
            End If
        End Sub

        Public Class TestData
            Private privateText As String
            Public Property Text() As String
                Get
                    Return privateText
                End Get
                Set(ByVal value As String)
                    privateText = value
                End Set
            End Property
            Private privateNumber? As Integer
            Public Property Number() As Integer?
                Get
                    Return privateNumber
                End Get
                Set(ByVal value? As Integer)
                    privateNumber = value
                End Set
            End Property
        End Class
    End Class
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SummaryType 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.

XAML

wpf-data-grid-process-frequent-data-updates/CS/ChunkAndOptSummariesExample/MainWindow.xaml#L18

<dxg:GridControl.TotalSummary>
    <dxg:GridSummaryItem SummaryType="Count" FieldName="Name" DisplayFormat="Total count: {0:N0}"/>
</dxg:GridControl.TotalSummary>

dxtreelist-how-to-implement-summary-footers-e4793/CS/MainWindow.xaml#L32

<dxg:TreeListControl.TotalSummary>
    <dxg:TreeListSummaryItem FieldName="Id" SummaryType="Sum"/>
    <dxg:TreeListSummaryItem FieldName="Id" SummaryType="Count"/>

XPO_how-to-bind-data-to-wpf-controls-using-xpservermodeview-or-xpinstantfeedbackview/CS/WpfApplication/MainWindow.xaml#L27

<dxg:GridControl.TotalSummary>
    <dxg:GridSummaryItem FieldName="TotalPrice" SummaryType="Sum" Alignment="Right"/>
    <dxg:GridSummaryItem SummaryType="Count" Alignment="Left" />

how-to-apply-sorting-by-summary-along-with-sorting-by-the-column-e4611/CS/GroupSorting/MainWindow.xaml#L33

<dxg:GridSummaryItem FieldName="Amount"
                     SummaryType="Sum"
                     DisplayFormat="N"/>

how-to-display-total-summaries-e1636/CS/DXGrid_DisplayTotals/Window1.xaml#L9

<dxg:GridControl.TotalSummary>
    <dxg:GridSummaryItem FieldName="UserName" SummaryType="Count"
                          DisplayFormat="Total Users: {0}"/>

C#

how-to-align-a-group-summary-to-the-left-within-a-group-row-e2400/CS/LeftAlignSummary/Window1.xaml.cs#L40

GridGroupSummaryData data = item as GridGroupSummaryData;
if(data.SummaryItem.SummaryType == SummaryItemType.Count)
    return EmptyTemplate;

how-to-convert-and-then-print-gridcontrol-by-using-xtrareport-e4658/CS/DXGridSample/ReportHelper.cs#L53

label.Summary.FormatString = item.DisplayFormat;
label.Summary.Func = GetSummaryFunc(item.SummaryType);
report.Bands[BandKind.ReportFooter].Controls.Add(label);

dxtreelist-how-to-implement-summary-footers-e4793/CS/MyTreeListView.xaml.cs#L153

        summaryValues[Grid.Columns[item.FieldName]] += "\n";
    summaryValues[Grid.Columns[item.FieldName]] += item.SummaryType + " = " + value.Value;
}

VB.NET

how-to-align-a-group-summary-to-the-left-within-a-group-row-e2400/VB/LeftAlignSummary/Window1.xaml.vb#L43

Dim data As GridGroupSummaryData = TryCast(item, GridGroupSummaryData)
If data.SummaryItem.SummaryType = SummaryItemType.Count Then
    Return EmptyTemplate

how-to-convert-and-then-print-gridcontrol-by-using-xtrareport-e4658/VB/DXGridSample/ReportHelper.vb#L54

label.Summary.FormatString = item.DisplayFormat
label.Summary.Func = GetSummaryFunc(item.SummaryType)
report.Bands(BandKind.ReportFooter).Controls.Add(label)

dxtreelist-how-to-implement-summary-footers-e4793/VB/MyTreeListView.xaml.vb#L193

    End If
    summaryValues(Grid.Columns(item.FieldName)) &= item.SummaryType & " = " & value.Value
Next value