GridColumn.AllowGrouping Property
Gets or sets a value that specifies whether an end-user can group data by the current column. This is a dependency property.
Namespace: DevExpress.Xpf.Grid
Assembly: DevExpress.Xpf.Grid.v24.2.dll
NuGet Package: DevExpress.Wpf.Grid.Core
Declaration
Property Value
Type | Description |
---|---|
DefaultBoolean | A DefaultBoolean enumeration value that specifies whether an end-user can group data by the current column. |
Available values:
Name | Description | Return Value |
---|---|---|
True | The value is true. |
|
False | The value is false. |
|
Default | The value is specified by a global option or a higher-level object. |
|
Remarks
End-users are allowed to group data if the view’s GridViewBase.AllowGrouping property is set to true. Individual columns provide the AllowGrouping property, allowing the default behavior specified by the view, to be overridden. Setting this property to ‘True’ or ‘False’ overrides the default behavior. This can be useful when it is required to prevent an end-user from grouping data by values of specific columns.
If the AllowGrouping property is set to ‘Default’, the ability to group data is controlled by the view’s GridViewBase.AllowGrouping property. In this instance, to obtain whether an end-user can group data by the current column, use the GridColumn.ActualAllowGrouping property.
To learn more, see Grouping.
Note
Data grouping requires data sorting to be performed. End-users can group data only if data sorting is allowed.
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the AllowGrouping 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.