Sorting Group Rows by Summary Values

• Jun 07, 2019
• 4 minutes to read

When the grid’s data is grouped, rows are always sorted against the grouping columns. By default, group rows are sorted in the order specified by the corresponding grouping column. If the grid displays group summaries, group rows can also be sorted by their summary values.

To sort group rows by their summary values in code:

• Create a new GridGroupSummarySortInfo object.
• Specify its GridGroupSummarySortInfo.FieldName (identifies the grouping column by its field name), GridGroupSummarySortInfo.SortOrder (specifies the sort order) and GridGroupSummarySortInfo.SummaryItem (represents the summary item used to calculate summary values) properties.
• Add this object to the GridControl.GroupSummarySortInfo collection.

After this object has been added to the collection, group rows are automatically sorted by their group summary values. To cancel sorting in code, remove this object from the collection.

End-users can sort group rows by summary values using a column header’s context menu. To learn more, see Sorting Group Rows by Summary.

Example

This example shows how to sort group row by summary values.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-sort-group-rows-by-summary-values-e1540.

Window1.xaml.cs

using System;
using System.Collections.Generic;
using System.Windows;
using System.Windows.Documents;
using DevExpress.Xpf.Grid;

namespace DXSample_SortGroupsBySummary {
    public partial class Window1 : Window {
        public Window1() {
            InitializeComponent();
            grid.ItemsSource = new AccountList().GetData();
            SortGroupsBySummary(view.GroupedColumns[0]);
        }
        private void SortGroupsBySummary(GridColumn column) {
            GridGroupSummarySortInfo sortInfo = new GridGroupSummarySortInfo(grid.GroupSummary[0],
                column.FieldName, System.ComponentModel.ListSortDirection.Ascending);
            grid.GroupSummarySortInfo.Add(sortInfo);
        }
    }
    public class AccountList {
        public List<Account> GetData() {
            return CreateAccounts();
        }
        private List<Account> CreateAccounts() {
            List<Account> list = new List<Account>();
            list.Add(new Account() { UserName = "Nick White", 
                RegistrationDate = DateTime.Today, Age = 57 });
            list.Add(new Account() { UserName = "Jack Rodman",
                RegistrationDate = new DateTime(2009, 5, 10), Age = 24 });
            list.Add(new Account() { UserName = "Sandra Sherry",
                RegistrationDate = new DateTime(2009, 5, 10), Age = 35 });
            list.Add(new Account() { UserName = "Sabrina Vilk",
                RegistrationDate = DateTime.Today, Age = 19 });
            list.Add(new Account() { UserName = "Mike Pearson",
                RegistrationDate = new DateTime(2008, 10, 18), Age = 42 });
            return list;
        }
    }
    public class Account {
        public string UserName { get; set; }
        public DateTime RegistrationDate { get; set; }
        public int Age { get; set; }
    }
}

Window1.xaml

<Window x:Class="DXSample_SortGroupsBySummary.Window1" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:dxg="http://schemas.devexpress.com/winfx/2008/xaml/grid"
        Title="Window1" Height="300" Width="484">
    <Grid>
        <dxg:GridControl x:Name="grid">
            <dxg:GridControl.Columns>
                <dxg:GridColumn FieldName="UserName">User Name</dxg:GridColumn>
                <dxg:GridColumn FieldName="RegistrationDate" GroupIndex="0">
                    Registration Date</dxg:GridColumn>
                <dxg:GridColumn FieldName="Age" />
            </dxg:GridControl.Columns>
            <dxg:GridControl.View>
                <dxg:TableView x:Name="view" AutoWidth="True" />
            </dxg:GridControl.View>
            <dxg:GridControl.GroupSummary>
                <dxg:GridSummaryItem FieldName="Age" SummaryType="Max" />
            </dxg:GridControl.GroupSummary>
        </dxg:GridControl>
    </Grid>
</Window>

Window1.xaml.vb

Imports Microsoft.VisualBasic
Imports System
Imports System.Collections.Generic
Imports System.Windows
Imports System.Windows.Documents
Imports DevExpress.Xpf.Grid

Namespace DXSample_SortGroupsBySummary
    Partial Public Class Window1
        Inherits Window
        Public Sub New()
            InitializeComponent()
            grid.ItemsSource = New AccountList().GetData()
            SortGroupsBySummary(view.GroupedColumns(0))
        End Sub
        Private Sub SortGroupsBySummary(ByVal column As GridColumn)
            Dim sortInfo As New GridGroupSummarySortInfo(grid.GroupSummary(0), column.FieldName, System.ComponentModel.ListSortDirection.Ascending)
            grid.GroupSummarySortInfo.Add(sortInfo)
        End Sub
    End Class
    Public Class AccountList
        Public Function GetData() As List(Of Account)
            Return CreateAccounts()
        End Function
        Private Function CreateAccounts() As List(Of Account)
            Dim list As New List(Of Account)()
            list.Add(New Account() With {.UserName = "Nick White", .RegistrationDate = DateTime.Today, .Age = 57})
            list.Add(New Account() With {.UserName = "Jack Rodman", .RegistrationDate = New DateTime(2009, 5, 10), .Age = 24})
            list.Add(New Account() With {.UserName = "Sandra Sherry", .RegistrationDate = New DateTime(2009, 5, 10), .Age = 35})
            list.Add(New Account() With {.UserName = "Sabrina Vilk", .RegistrationDate = DateTime.Today, .Age = 19})
            list.Add(New Account() With {.UserName = "Mike Pearson", .RegistrationDate = New DateTime(2008, 10, 18), .Age = 42})
            Return list
        End Function
    End Class
    Public Class Account
        Private privateUserName As String
        Public Property UserName() As String
            Get
                Return privateUserName
            End Get
            Set(ByVal value As String)
                privateUserName = value
            End Set
        End Property
        Private privateRegistrationDate As DateTime
        Public Property RegistrationDate() As DateTime
            Get
                Return privateRegistrationDate
            End Get
            Set(ByVal value As DateTime)
                privateRegistrationDate = value
            End Set
        End Property
        Private privateAge As Integer
        Public Property Age() As Integer
            Get
                Return privateAge
            End Get
            Set(ByVal value As Integer)
                privateAge = value
            End Set
        End Property
    End Class
End Namespace