Skip to main content
A newer version of this page is available. .

OptionsColumn.AllowGroup Property

Gets or sets whether end-users can drag the column’s header to the group panel to group data against the column’s values.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

[DefaultValue(DefaultBoolean.Default)]
[XtraSerializableProperty]
public DefaultBoolean AllowGroup { get; set; }

Property Value

Type Default Description
DefaultBoolean **Default**

A DefaultBoolean enumeration value specifying whether end-users can drag the column’s header to the group panel.

Available values:

Name Description
True

Corresponds to a Boolean value of true.

False

Corresponds to a Boolean value of false.

Default

The value is determined by the current object’s parent object setting (e.g., a control setting).

Property Paths

You can access this nested property as listed below:

Object Type Path to AllowGroup
GridColumn
.OptionsColumn.AllowGroup
LayoutViewColumn
.OptionsColumn.AllowGroup
BandedGridColumn
.OptionsColumn.AllowGroup

Remarks

Set the AllowGroup property to the DefaultBoolean.False value to prevent end-users from dragging the column’s header to the group panel. The data can however still be grouped against the column’s values via code regardless of the value of the column’s AllowGroup property.

If this property is set to the DefaultBoolean.Default value, the ability to drag the column’s header to the group panel is determined by the View’s GridOptionsCustomization.AllowGroup option.

Important note: data grouping requires data sorting to be performed. Thus, end-users can only group data when the column’s values can be sorted.

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AllowGroup property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

See Also