GridControl.GroupBy(String, Boolean) Method

Groups data by the values of the specified column.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v24.1.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public void GroupBy(
    string fieldName,
    bool mergeWithPreviousGroup = false
)

VB.NET

Public Sub GroupBy(
    fieldName As String,
    mergeWithPreviousGroup As Boolean = False
)

Parameters

Name	Type	Description
fieldName	String	A String value that specifies the column’s field name.

Optional Parameters

Name	Type	Default	Description
mergeWithPreviousGroup	Boolean	False	A boolean value that specifies whether the current grouping should be merged with a previous grouping (according to group index).

Remarks

The GridControl supports data grouping by an unlimited number of columns. The GroupBy method groups data by the values of the specified column.

Data rows are always sorted against the grouping columns. If data is grouped against a column which isn’t sorted, the grid automatically applies sorting in ascending order to this column.

To learn more, see Grouping.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GroupBy(String, Boolean) method.

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#

wpf-dock-layout-manager-use-the-layout-upgrade-event-to-upgrade-a-layout-from-one-version-to-another/CS/MainWindow.xaml.cs#L43

if (e.RestoredVersion == "1.0") {
    ((GridControl)sender).GroupBy("Group");
}

VB.NET

wpf-dock-layout-manager-use-the-layout-upgrade-event-to-upgrade-a-layout-from-one-version-to-another/VB/MainWindow.xaml.vb#L54

If Equals(e.RestoredVersion, "1.0") Then
    CType(sender, GridControl).GroupBy("Group")
End If