GridGroupSummarySortInfoCollection Class

Represents a collection which contains the information required to sort the group rows by summary values.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v23.2.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public class GridGroupSummarySortInfoCollection :
    ObservableCollectionCoreWithRemoveSafe<GridGroupSummarySortInfo>

VB.NET

Public Class GridGroupSummarySortInfoCollection
    Inherits ObservableCollectionCoreWithRemoveSafe(Of GridGroupSummarySortInfo)

Related API Members

The following members return GridGroupSummarySortInfoCollection objects:

• GridControl.GroupSummarySortInfo

Remarks

To sort group rows by summary values:

1. Create a GridGroupSummarySortInfo object.
2. Specify its settings (group summary item, grouping column’s field name and sort order).
3. Add this object to the GridControl.GroupSummarySortInfo collection.

This example demonstrates how to sort group rows by summary values in code:

View Example: Sort Group Rows by Summary Values

C#

public partial class Window1 : Window {
    public Window1() {
        InitializeComponent();
        grid.ItemsSource = AccountList.GetData();
        SortGroupsBySummary(view.GroupedColumns[0]);
    }
    void SortGroupsBySummary(GridColumn column) {
        GridGroupSummarySortInfo sortInfo = new GridGroupSummarySortInfo(grid.GroupSummary[0],
            column.FieldName, System.ComponentModel.ListSortDirection.Ascending);
        grid.GroupSummarySortInfo.Add(sortInfo);
    }
}

VB.NET

Public Partial Class Window1
    Inherits Window

    Public Sub New()
        Me.InitializeComponent()
        Me.grid.ItemsSource = AccountList.GetData()
        Me.SortGroupsBySummary(Me.view.GroupedColumns(0))
    End Sub

    Private Sub SortGroupsBySummary(ByVal column As GridColumn)
        Dim sortInfo As GridGroupSummarySortInfo = New GridGroupSummarySortInfo(Me.grid.GroupSummary(0), column.FieldName, System.ComponentModel.ListSortDirection.Ascending)
        Me.grid.GroupSummarySortInfo.Add(sortInfo)
    End Sub
End Class

XAML

<dxg:GridControl x:Name="grid">
    <dxg:GridColumn FieldName="UserName"/>
    <dxg:GridColumn FieldName="RegistrationDate" GroupIndex="0"/>
    <dxg:GridColumn FieldName="Age"/>
    <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>

Remove the GridGroupSummarySortInfo object from the GridControl.GroupSummarySortInfo collection to clear the summary sorting.

Refer to the following help topic for more information: Sorting Group Rows by Summary Values.

Inheritance

Object

Collection<GridGroupSummarySortInfo>

ObservableCollection<GridGroupSummarySortInfo>

DevExpress.Xpf.Core.ObservableCollectionCore<GridGroupSummarySortInfo>

DevExpress.Xpf.Grid.Native.ObservableCollectionCoreWithRemoveSafe<GridGroupSummarySortInfo>

GridGroupSummarySortInfoCollection