ColumnBase.AllowSorting Property

Gets or sets whether an end-user can sort data by the column’s values. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v23.2.Core.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public DefaultBoolean AllowSorting { get; set; }

VB.NET

Public Property AllowSorting As DefaultBoolean

Property Value

Type	Description
DefaultBoolean	A DefaultBoolean enumeration value that specifies whether an end-user 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

Remarks

End-users are allowed to sort data if the view’s DataViewBase.AllowSorting property is set to true. Individual columns provide the AllowSorting 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 sorting data by values of specific columns.

If the AllowSorting property is set to ‘Default’, the ability to sort data is controlled by the view’s DataViewBase.AllowSorting property. In this instance, to obtain whether an end-user can sort data by the current column, use the ColumnBase.ActualAllowSorting property.

Note

If the AllowSorting property is set to false, the grid does not synchronise its sorting and grouping with the ICollectionView.

To learn more, see Sorting.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the AllowSorting 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.

XAML

wpf-data-grid-bind-to-infiniteasyncsource/CS/InfiniteAsyncSourceSample/MainWindow.xaml#L21

<dxg:GridColumn FieldName="Created" IsSmart="True" AllowEditing="True" Width="*"
                AllowSorting="True" AllowedSortOrders="Descending"
                AllowedDateTimeFilters="SingleDateRange" FilterPopupMode="DateSmart">

wpf-data-grid-bind-to-pagedasyncsource/CS/PagedAsyncSourceSample/MainWindow.xaml#L17

<dxg:GridColumn FieldName="Created" IsSmart="True" Width="*"
                AllowSorting="True" AllowedSortOrders="Descending"
                AllowedDateTimeFilters="SingleDateRange" FilterPopupMode="DateSmart">

wpf-data-grid-bind-to-custom-service-with-restrictions/CS/MainWindow.xaml#L16

<dxg:GridControl.Columns>
    <dxg:GridColumn x:Name="hotColumn" FieldName="Hot" Visible="False" ShowInColumnChooser="False" AllowSorting="True" AllowedSortOrders="Descending" SortOrder="Descending" />
    <dxg:GridColumn x:Name="weekColumn" FieldName="Week" Visible="False" ShowInColumnChooser="False" AllowSorting="True" AllowedSortOrders="Descending" />

wpf-data-grid-use-skip-tokens-to-optimize-paging-EF/CS/MainWindow.xaml#L17

<dxg:GridColumn FieldName="Created" IsSmart="True" Width="*"
                AllowSorting="True" DefaultSortOrder="Descending"
                AllowedDateTimeFilters="SingleDateRange" FilterPopupMode="DateSmart">

wpf-data-grid-use-virtual-sources-to-bind-to-in-memory-data/CS/MainWindow.xaml#L17

<dxg:GridColumn FieldName="Created" IsSmart="True" Width="*"
                AllowSorting="True" AllowedSortOrders="Descending"
                AllowedDateTimeFilters="SingleDateRange" FilterPopupMode="DateSmart">