OptionsColumn.AllowSort Property
Gets or sets whether end-users can sort data by the column’s values.
Namespace: DevExpress.XtraGrid.Columns
Assembly: DevExpress.XtraGrid.v19.2.dll
Declaration
[DefaultValue(DefaultBoolean.Default)]
[XtraSerializableProperty]
public DefaultBoolean AllowSort { get; set; }Property Value
| Type | Default | Description |
|---|---|---|
| DefaultBoolean | **Default** | A DefaultBoolean enumeration value specifying whether end-users can sort data by the column’s values. |
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 AllowSort |
|---|---|
| GridColumn |
|
| LayoutViewColumn |
|
| BandedGridColumn |
|
Remarks
The DefaultBoolean.Default value assigned to the AllowSort property is interpreted differently, based on the type of the underlying data:
- For simple data types (text, date-time and numeric values) - the ability to sort a column’s values is determined by the View’s GridOptionsCustomization.AllowSort property.
- For binary or custom data - the DefaultBoolean.Default value is interpreted as false.
A sortable column’s values can be sorted in code regardless of the AllowSort property’s value. To do this, use the column’s GridColumn.SortIndex property.
Note
Data grouping requires sorting to be applied. So, disabling data sorting results in disabling grouping.
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the AllowSort 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.