GridControl.GroupCount Property

Gets or sets the number of grouping columns.

Namespace: DevExpress.Xpf.Grid

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

Declaration

C#

[DefaultValue(0)]
[Browsable(false)]
public int GroupCount { get; set; }

VB.NET

<DefaultValue(0)>
<Browsable(False)>
Public Property GroupCount As Integer

Property Value

Type	Default	Description
Int32	0	An integer value that specifies the number of grouping columns.

Remarks

To sort data in code, you should create a GridSortInfo object, specify its GridSortInfo.FieldName and GridSortInfo.SortOrder properties, and add it to the grid’s GridControl.SortInfo collection. The first few objects contained within the GridControl.SortInfo collection correspond to grouping columns. The number of these objects is specified by the GroupCount property.

The grid automatically recalculates the GroupCount property’s value each time the number of grouping columns is changed by an end-user or via code using the GridControl.GroupBy or GridControl.UngroupBy methods.

Setting the GroupCount property to a new value which is less than the current number of grouping columns, automatically ungroups data by the values of excess columns.

To learn more, see Grouping Overview.

Example

This example shows how to apply data sorting and grouping in XAML.

Since group rows are always sorted, data grouping requires data sorting. Sorting applied to group columns takes priority over other columns. To group data by one column in XAML, do the following:

• Create a GridSortInfo object and specify its GridSortInfo.FieldName and GridSortInfo.SortOrder properties. The GridSortInfo.FieldName property specifies the grouping column by its field name.
• Add the GridSortInfo object to the grid’s GridControl.SortInfo collection. This object must be the first element in this collection.
• Finally, set the grid’s GridControl.GroupCount property to 1. This specifies that the first element in the GridControl.SortInfo collection corresponds to the grouping column.

The image below shows the result:

C#

using System.ComponentModel;
using DevExpress.Xpf.Grid;

public Window1() {
    InitializeComponent();
    grid.DataSource =
        new dsNwindProductsTableAdapters.ProductsTableAdapter().GetData();
    CreateSortInfo(grid);
}
private void CreateSortInfo(GridControl grid) {
    grid.SortInfo.Add(new GridSortInfo("UnitPrice", ListSortDirection.Descending));
    grid.SortInfo.Add(new GridSortInfo("ProductName", ListSortDirection.Ascending));
    grid.GroupCount = 1;
}

XAML

<dxg:GridControl x:Name="grid" GroupCount="1">
    <dxg:GridControl.Columns>
        <dxg:GridColumn FieldName="ProductName"/>
        <dxg:GridColumn FieldName="UnitPrice"/>
        <dxg:GridColumn FieldName="UnitsOnOrder" Header="Units On Order"/>
    </dxg:GridControl.Columns>
    <dxg:GridControl.View>
        <dxg:TableView AutoWidth="True" ShowGroupedColumns="False"/>
    </dxg:GridControl.View>
    <dxg:GridControl.SortInfo>
        <dxg:GridSortInfo FieldName="UnitPrice" SortOrder="Descending"/>
        <dxg:GridSortInfo FieldName="ProductName" SortOrder="Ascending"/>
    </dxg:GridControl.SortInfo>
</dxg:GridControl>

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GroupCount 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-implement-the-drag-and-drop-capability-to-move-a-row-from-one-group-to-another-e1193/CS/Window1.xaml#L2

<Window x:Class="DragAndDrop_ChangeGroup.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" xmlns:local="clr-namespace:DragAndDrop_ChangeGroup" Title="Window1" Height="600" Width="800">
    <dxg:GridControl x:Name="grid" DockPanel.Dock="Left" AutoGenerateColumns="AddNew" GroupCount="1">
        <dxg:GridControl.SortInfo>

how-to-preserve-the-dxgrid-for-wpf-view-state-e4222/CS/SaveWpfGridState/RowStateHelper.cs#L109

void SaveExpansionView() {
    if (gridControl.GroupCount == 0)
        return;

how-to-add-draganddrop-capability-to-the-detail-grid-t163179/CS/DragAndDropExample/Behavior/CustomGridDragAndDrop.cs#L171

{
    return grid.GroupCount > 0;
}

how-to-handle-grid-commands-in-xaml-and-code-behind-e373/VB/Window1.xaml#L8

<StackPanel>
    <dxg:GridControl Name="gridControl1" VerticalAlignment="Top" Height="296" GroupCount="1">
        <dxg:GridControl.View>

how-to-create-checkable-grouping-in-gridcontrol-t127563/CS/DevExpress.Example03/CheckableGroupBehavior.cs#L95

if(this.AssociatedObject.GroupCount > 0) {
    this.AssociatedObject_EndGrouping(null, null);

VB.NET

how-to-preserve-the-dxgrid-for-wpf-view-state-e4222/VB/SaveWpfGridState/RowStateHelper.vb#L110

Private Sub SaveExpansionView()
    If gridControl.GroupCount = 0 Then
        Return

how-to-add-draganddrop-capability-to-the-detail-grid-t163179/VB/DragAndDropExample/Behavior/CustomGridDragAndDrop.vb#L148

Protected Function IsGrouped(ByVal grid As GridControl) As Boolean
    Return grid.GroupCount > 0
End Function

how-to-create-checkable-grouping-in-gridcontrol-t127563/VB/DevExpress.Example03/CheckableGroupBehavior.vb#L103

If Me.AssociatedObject.GroupCount > 0 Then
    Me.AssociatedObject_EndGrouping(Nothing, Nothing)