GridControl.GroupSummarySortInfo Property

Gets the information required to sort group rows by summary values.

Namespace: DevExpress.Xpf.Grid

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

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

Declaration

C#

[Browsable(false)]
public GridGroupSummarySortInfoCollection GroupSummarySortInfo { get; }

VB.NET

<Browsable(False)>
Public ReadOnly Property GroupSummarySortInfo As GridGroupSummarySortInfoCollection

Property Value

Type	Description
GridGroupSummarySortInfoCollection	The information required to sort group rows by summary values.

Remarks

Sort Group Rows by Summary In Code

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 GroupSummarySortInfo collection.

View Example

C#

private void SortGroupsBySummary(GridColumn column) {
    GridGroupSummarySortInfo sortInfo = new GridGroupSummarySortInfo(grid.GroupSummary[0],
        column.FieldName, System.ComponentModel.ListSortDirection.Ascending);
    grid.GroupSummarySortInfo.Add(sortInfo);
}

VB

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

To clear sorting, remove the GridGroupSummarySortInfo object from the GroupSummarySortInfo collection.

Sort Group Rows by Summary In UI

End users can press the Sort By Summary context menu’s button to sort group rows by summary values:

To clear sorting, end users should select the Clear Summary Sorting item from the grouping column’s header context menu.

Refer to the Sorting Group Rows by Summary Values and Sorting Group Rows by Summary topics for more information.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GroupSummarySortInfo 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.

C#

how-to-apply-sorting-by-summary-along-with-sorting-by-the-column-e4611/CS/GroupSorting/GroupSummaryOptions.cs#L87

static GridGroupSummarySortInfo FindGridGroupSummarySortInfo(GridControl Grid, string FieldName) {
    foreach (GridGroupSummarySortInfo sortInfo in Grid.GroupSummarySortInfo)
        if (sortInfo.SummaryItem.FieldName == FieldName)

VB.NET

how-to-apply-sorting-by-summary-along-with-sorting-by-the-column-e4611/VB/GroupSorting/GroupSummaryOptions.vb#L73

Private Shared Function FindGridGroupSummarySortInfo(ByVal Grid As GridControl, ByVal FieldName As String) As GridGroupSummarySortInfo
    For Each sortInfo As GridGroupSummarySortInfo In Grid.GroupSummarySortInfo
        If sortInfo.SummaryItem.FieldName = FieldName Then