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

C#

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

VB.NET

<DefaultValue(DefaultBoolean.Default)>
<XtraSerializableProperty>
Public Property AllowSort As DefaultBoolean

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:

• 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.

C#

winforms-grid-display-editors-in-columns-headers/CS/WindowsApplication1/Form1.cs#L34

new ColumnInplaceEditorHelper(gridColumn1, new RepositoryItemSpinEdit());
gridColumn1.OptionsColumn.AllowSort = DevExpress.Utils.DefaultBoolean.False;
gridColumn1.OptionsFilter.AllowFilter = false;

winforms-grid-multiple-row-selection-web-style-checkboxes/CS/E1271/CheckMarkSelection.cs#L117

column = view.Columns.Add();
column.OptionsColumn.AllowSort = DevExpress.Utils.DefaultBoolean.False;
column.Visible = true;

XAF-how-to-add-an-unbound-column-to-gridlisteditor-to-execute-a-custom-action-for-a-record/CS/WinSolution.Module.Win/SimpleBusinessActionGridListViewController.cs#L66

buttonColumn.OptionsColumn.AllowSize = false;
buttonColumn.OptionsColumn.AllowSort = DefaultBoolean.False;
buttonColumn.OptionsColumn.FixedWidth = true;

VB.NET

winforms-grid-display-editors-in-columns-headers/VB/Form1.vb#L33

Dim helper As ColumnInplaceEditorHelper = New ColumnInplaceEditorHelper(gridColumn1, New RepositoryItemSpinEdit())
gridColumn1.OptionsColumn.AllowSort = DevExpress.Utils.DefaultBoolean.False
gridColumn1.OptionsFilter.AllowFilter = False

winforms-grid-multiple-row-selection-web-style-checkboxes/VB/E1271/CheckMarkSelection.vb#L146

column = view.Columns.Add()
column.OptionsColumn.AllowSort = Utils.DefaultBoolean.False
column.Visible = True

XAF-how-to-add-an-unbound-column-to-gridlisteditor-to-execute-a-custom-action-for-a-record/VB/WinSolution.Module.Win/SimpleBusinessActionGridListViewController.vb#L81

buttonColumn.OptionsColumn.AllowSize = False
buttonColumn.OptionsColumn.AllowSort = DefaultBoolean.False
buttonColumn.OptionsColumn.FixedWidth = True