GridControl.GroupBy(GridColumn, Int32, Boolean) Method

Groups data by the values of the specified column. If several columns are involved in grouping, the specified column will reside at the specified grouping level.

Namespace: DevExpress.Xpf.Grid

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

Declaration

public void GroupBy(
    GridColumn column,
    int groupedIndex,
    bool mergeWithPreviousGroup = false
)
Public Sub GroupBy(
    column As GridColumn,
    groupedIndex As Integer,
    mergeWithPreviousGroup As Boolean = False
)

Parameters

Name Type Description
column GridColumn

A GridColumn object that represents the column by whose values data is grouped.

groupedIndex Int32

A zero-based integer value that specifies the grouping level. If negative, an exception is raised.

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. If several columns are involved in grouping, the groupedIndex parameter specifies the grouping level.

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.

See Also