GridColumn.GroupInterval Property

Gets or sets how data rows are grouped when grouping by the current column is applied. Certain limitations apply in server mode.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v20.1.dll

Declaration

[DXCategory("Data")]
[DefaultValue(ColumnGroupInterval.Default)]
[XtraSerializableProperty]
[XtraSerializablePropertyId(2)]
public ColumnGroupInterval GroupInterval { get; set; }
<DXCategory("Data")>
<DefaultValue(ColumnGroupInterval.Default)>
<XtraSerializableProperty>
<XtraSerializablePropertyId(2)>
Public Property GroupInterval As ColumnGroupInterval

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.

Remarks

When data is grouped by a specific column, the View's rows are combined into groups. By default, each group contains rows which have the same value in the field (column) for which grouping has been applied. Use the GroupInterval property to change the logic used to decide which rows should be grouped together. For instance, for a column that displays date/time information, you can set its GroupInterval property to ColumnGroupInterval.DateYear. In this case, when grouping is applied against this column, the data rows will be combined into groups according to the year part of their values. See the ColumnGroupInterval topic, for information on the other options.

The order in which group rows are arranged is specified by the GridColumn.SortOrder and GridColumn.SortMode properties.

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

See Working with Groups in Code for an overview of group modes.

Group rows can be painted in the standard manner or using the Office2003 paint style. To specify how group rows should be painted, use the GridOptionsView.GroupDrawMode property.

An end-user can change the group interval for date-time columns at runtime via a context menu if the GridOptionsMenu.ShowDateTimeGroupIntervalItems option is enabled.

NOTE

The GroupInterval property is not supported in server mode when binding with the WcfServerModeSource and WcfInstantFeedbackSource. For limitations on using other server mode data sources, see ColumnGroupInterval and Large Data Sources: Server and Instant Feedback Modes.

See Also