ColumnGroupInterval Enum

Lists the values that specify how the data rows are combined into groups when in grouping mode.

Namespace: DevExpress.XtraGrid

Assembly: DevExpress.Data.v20.1.dll

Declaration

public enum ColumnGroupInterval
Public Enum ColumnGroupInterval

Members

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:
"Beyond Next Month",
"Next Month",
"Later this Month",
"Three Weeks Away",
"Two Weeks Away",
"Next Week",
"Today",
"Tomorrow",
"Yesterday",
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Last Week",
"Two Weeks Ago",
"Three Weeks Ago",
"Earlier this Month",
"Last Month",
"Older".

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.

Related API Members

The following properties accept/return ColumnGroupInterval values:

Library Related API Members
WinForms Controls GridColumn.GroupInterval
WPF Controls GridColumn.GroupInterval
ASP.NET Controls and MVC Extensions CardViewDataColumnSettings.GroupInterval
GridViewDataColumnSettings.GroupInterval
ASP.NET Bootstrap Controls BootstrapCardViewColumnSettings.GroupInterval
Windows 10 App Controls GridColumnBase.GroupInterval

Remarks

A grid column's GroupInterval property of the ColumnGroupInterval type specifies how rows are combined into groups when data is grouped against this column. By default, the rows whose grouping column values match are combined into the same groups.

To provide custom grouping logic when data is grouped by a specific column, set the column's SortMode property to Custom and handle the grid's CustomColumnGroup event.

NOTE

Combining rows into groups using the GroupInterval property is not supported when binding to WCF Data Services in Server Mode.

See Also