The requested page is not available for the requested platform. You are viewing the content for Default platform.

ASPxClientGridView.GroupBy(column) Method

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

Declaration

GroupBy(column: ASPxClientGridViewColumn | number | string, groupIndex?: number, sortOrder?: string): void

Parameters

Name Type Description
column ASPxClientGridViewColumn | number | string

Optional Parameters

Name Type Default Description
groupIndex number null

An integer value that specifies the grouping level. -1 to cancel grouping by the column's values.

sortOrder string null

A string value that specifies the column's sort order.

Remarks

The ASPxGridView supports data grouping by an unlimited number of data columns. The GroupBy method groups data by the values of the specified column. If several columns are involved in grouping, the value parameter specifies the grouping level. Data rows are always sorted against the grouping columns. The sortOrder parameter allows the grouping column's sort order to be specified.

Data grouping is allowed if the ASPxGridViewBehaviorSettings.AllowGroup and ASPxGridBehaviorSettings.AllowSort properties are set to true.

See Also