GridViewDataColumnSettings.GroupInterval Property
Gets or sets how data rows are grouped when grouping by the current column is applied.
Namespace: DevExpress.Web
Assembly: DevExpress.Web.v19.2.dll
Declaration
[DefaultValue(ColumnGroupInterval.Default)]
public ColumnGroupInterval GroupInterval { get; set; }Property Value
| Type | Default | Description |
|---|---|---|
| ColumnGroupInterval | **Default** | A ColumnGroupInterval value that determines how data rows are grouped when grouping by the current column is applied. |
Available values:
| Name | Description |
|---|---|
| Default | For columns which store date/time values, this option is the same as the ColumnGroupInterval.Date option. For non date/time columns this option is the same as the ColumnGroupInterval.Value option. |
| Value | Rows are grouped by values of grouping columns. The number of groups matches the number of unique values within the grouping column. For date/time columns, both the date and time portions are taken into account for value comparison. To specify how date/time values are presented in group rows in WinForms Data Grid, apply formatting to the grouping column (e.g., with the GridColumn.DisplayFormat property). |
| Date | This option is in effect only for columns that store date/time values. Rows are grouped by the date part of their values, the time portion is ignored in this grouping mode. |
| DateMonth | This option is in effect only for columns that store date/time values. Rows are grouped by the month part of their values. |
| DateYear | This option is in effect only for columns that store date/time values. Rows are grouped by the year part of their values. |
| DateRange | This option is in effect for columns that store date/time values. Rows are combined into the following non-overlapping groups according to their date value as compared with today’s date: |
| Alphabetical | Rows are grouped by the character that grouping column values start with. Note Not supported in server mode for numeric and date/time columns. |
| DisplayText | Rows are grouped by display values of the grouping column. In specific instances, column cells can have different edit values, but the same display value. To combine these rows into the same group, use the DisplayText group mode. Note Not supported in server mode. |
Property Paths
You can access this nested property as listed below:
Remarks
Set the GroupInterval property to ‘Alphabetical’ to group text columns by the first characters. Date-time columns can be grouped by month, year, etc.
The order in which group rows are arranged is specified by the GridViewDataColumn.SortOrder and GridDataColumnSettings.SortMode properties.
To implement custom grouping logic, set the column’s GridDataColumnSettings.SortMode property to ‘Custom’ and handle the ASPxGridView.CustomColumnGroup event.
For more information, see Grouping Modes and Custom Grouping.
Note
Group modes and custom grouping are not supported in server mode. In this mode, rows are always grouped by values of grouping columns.
Note
The ASPxGridView.EnableRowsCache option must be disabled when using custom grouping intervals defined via the GroupInterval property.