A newer version of this page is available.
Switch to the current version.
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.1.dll
Declaration
[DefaultValue(DefaultBoolean.Default)]
[XtraSerializableProperty]
public DefaultBoolean AllowSort { get; set; }<DefaultValue(DefaultBoolean.Default)>
<XtraSerializableProperty>
Public Property AllowSort As DefaultBooleanProperty Value
| Type | Default | Description |
|---|---|---|
| DefaultBoolean | Default |
A DefaultBoolean enumeration value specifying whether end-users can sort data by the column's values. |
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.
See Also
Feedback