Skip to main content

OptionsColumn.AllowSort Property

Gets or sets whether end-users can sort data by the column’s values.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v24.1.dll

NuGet Packages: DevExpress.Win.Grid, DevExpress.Win.Navigation

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 Return Value
True

The value is true.

0

False

The value is false.

1

Default

The value is specified by a global option or a higher-level object.

2

Property Paths

You can access this nested property as listed below:

Object Type Path to AllowSort
GridColumn
.OptionsColumn .AllowSort

Remarks

The DefaultBoolean.Default value assigned to the AllowSort property is interpreted differently, based on the type of the underlying data:

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.

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.

See Also