BuyLog In
DevExtreme
All docs
V 17.2
25.2
The page you are viewing does not exist in version 25.2.
25.1
The page you are viewing does not exist in version 25.1.
24.2
The page you are viewing does not exist in version 24.2.
24.1
The page you are viewing does not exist in version 24.1.
23.2
The page you are viewing does not exist in version 23.2.
23.1
The page you are viewing does not exist in version 23.1.
22.2
The page you are viewing does not exist in version 22.2.
22.1
The page you are viewing does not exist in version 22.1.
21.2
The page you are viewing does not exist in version 21.2.
21.1
The page you are viewing does not exist in version 21.1.
20.2
The page you are viewing does not exist in version 20.2.
20.1
The page you are viewing does not exist in version 20.1.
19.2
19.1
18.2
18.1
17.2
All docs
V17.2

General Information

.NET Subscription

What's Included
DevExpress Installation
DevExpress Code Examples

Common Tools

Project Converter
Assembly Deployment Tool
Localization Service

Quality Assurance and Productivity

CodeRush for Visual Studio (FREE)
TestCafe Studio

Desktop

Controls

WinForms
WPF
VCL
WinUI

Tools

WinForms Skin Editor
WPF Theme Designer
WPF Theme Editor (Legacy)
Coded UI Test Extension

Frameworks and Libraries

XAF - Cross-Platform .NET App UI
XPO - .NET ORM Library (FREE)
XPO Profiler
Core Libraries
Drawing Graphics Library
.NET App Security & Web API Service (FREE)

Web

Controls and Extensions

ASP.NET Web Forms Controls
ASP.NET MVC Extensions
ASP.NET Core Controls
ASP.NET Bootstrap Controls
DevExtreme
DevExtreme ASP.NET MVC Controls
Blazor Components

Tools

ASP.NET Theme Builder
ASP.NET Theme Deployer

Maintenance Mode

ASP.NET Core Bootstrap Controls

Mobile

Xamarin UI Controls (FREE)
.NET MAUI (FREE)

Enterprise and Analytic Tools

Reporting
Report and Dashboard Server
BI Dashboard
Office File API

End-User Documentation

Interface Elements for Desktop
Interface Elements for Web
Dashboard for Desktop
Dashboard for Web
25.2
The page you are viewing does not exist in version 25.2.
25.1
The page you are viewing does not exist in version 25.1.
24.2
The page you are viewing does not exist in version 24.2.
24.1
The page you are viewing does not exist in version 24.1.
23.2
The page you are viewing does not exist in version 23.2.
23.1
The page you are viewing does not exist in version 23.1.
22.2
The page you are viewing does not exist in version 22.2.
22.1
The page you are viewing does not exist in version 22.1.
21.2
The page you are viewing does not exist in version 21.2.
21.1
The page you are viewing does not exist in version 21.1.
20.2
The page you are viewing does not exist in version 20.2.
20.1
The page you are viewing does not exist in version 20.1.
19.2
19.1
18.2
18.1
17.2
Full-text search
API Reference
UI Widgets
Accordion
ActionSheet
Autocomplete
BarGauge
Box
Bullet
Button
Calendar
Chart
CheckBox
CircularGauge
ColorBox
ContextMenu
DataGrid
DateBox
DeferRendering
DropDownBox
Exporter
FileUploader
FilterBuilder
Form
Funnel
Gallery
LinearGauge
List
LoadIndicator
LoadPanel
Lookup
Map
Menu
MultiView
NavBar
NumberBox
Panorama
PieChart
Pivot
PivotGrid
PivotGridFieldChooser
PolarChart
Popover
Popup
ProgressBar
RadioGroup
RangeSelector
RangeSlider
Resizable
ResponsiveBox
Scheduler
ScrollView
SelectBox
SlideOut
SlideOutView
Slider
Sparkline
Switch
TabPanel
Tabs
TagBox
TextArea
TextBox
TileView
Toast
Toolbar
Tooltip
TreeList
Configuration
accessKey
activeStateEnabled
allowColumnReordering
allowColumnResizing
autoExpandAll
cacheEnabled
cellHintEnabled
columnAutoWidth
columnChooser
columnFixing
columnHidingEnabled
columnMinWidth
columnResizingMode
columns[]
customizeColumns
dataSource
dataStructure
dateSerializationFormat
disabled
editing
elementAttr
errorRowEnabled
expandedRowKeys
expandNodesOnFiltering
filterRow
focusStateEnabled
hasItemsExpr
headerFilter
height
hint
hoverStateEnabled
itemsExpr
keyExpr
loadPanel
noDataText
onAdaptiveDetailRowPreparing
onCellClick
onCellHoverChanged
onCellPrepared
onContentReady
onContextMenuPreparing
onDataErrorOccurred
onDisposing
onEditingStart
onEditorPrepared
onEditorPreparing
onInitialized
onInitNewRow
onKeyDown
onNodesInitialized
onOptionChanged
onRowClick
onRowCollapsed
onRowCollapsing
onRowExpanded
onRowExpanding
onRowInserted
onRowInserting
onRowPrepared
onRowRemoved
onRowRemoving
onRowUpdated
onRowUpdating
onRowValidating
onSelectionChanged
onToolbarPreparing
parentIdExpr
remoteOperations
rootValue
rowAlternationEnabled
rtlEnabled
scrolling
searchPanel
selectedRowKeys
selection
showBorders
showColumnHeaders
showColumnLines
showRowLines
sorting
ascendingText
clearText
descendingText
mode
tabIndex
twoWayBindingEnabled
visible
width
wordWrapEnabled
Methods
Events
Node
Row
TreeMap
TreeView
ValidationGroup
ValidationSummary
Validator
VectorMap
Markup Components
UI Events
CSS Classes
Data Layer
SPA Framework
Types
Utilities
Getting Started
ASP.NET MVC Controls
SPA Framework
VS Integration
Widgets
Data Binding
Common Features

General Information

.NET Subscription

What's Included
DevExpress Installation
DevExpress Code Examples

Common Tools

Project Converter
Assembly Deployment Tool
Localization Service

Quality Assurance and Productivity

CodeRush for Visual Studio (FREE)
TestCafe Studio

Desktop

Controls

WinForms
WPF
VCL
WinUI

Tools

WinForms Skin Editor
WPF Theme Designer
WPF Theme Editor (Legacy)
Coded UI Test Extension

Frameworks and Libraries

XAF - Cross-Platform .NET App UI
XPO - .NET ORM Library (FREE)
XPO Profiler
Core Libraries
Drawing Graphics Library
.NET App Security & Web API Service (FREE)

Web

Controls and Extensions

ASP.NET Web Forms Controls
ASP.NET MVC Extensions
ASP.NET Core Controls
ASP.NET Bootstrap Controls
DevExtreme
DevExtreme ASP.NET MVC Controls
Blazor Components

Tools

ASP.NET Theme Builder
ASP.NET Theme Deployer

Maintenance Mode

ASP.NET Core Bootstrap Controls

Mobile

Xamarin UI Controls (FREE)
.NET MAUI (FREE)

Enterprise and Analytic Tools

Reporting
Report and Dashboard Server
BI Dashboard
Office File API

End-User Documentation

Interface Elements for Desktop
Interface Elements for Web
Dashboard for Desktop
Dashboard for Web
A newer version of this page is available. Switch to the current version.

JavaScript/jQuery TreeList - sorting

Configures runtime sorting.

Type:

Object

A user can sort rows by values of a single or multiple columns depending on the value of the sorting.mode option.

DevExtreme HTML5 JavaScript jQuery Angular Knockout Widget TreeList Sorting

To apply sorting to a column, a user clicks its header or selects a command from the context menu.

DevExtreme HTML5 JavaScript jQuery Angular Knockout Widget TreeList Sorting

Note that rows are sorted within their hierarchical level.

View Demo

See Also

ascendingText

Specifies text for the context menu item that sets an ascending sort order in a column.

Type:

String

Default Value: 'Sort Ascending'

clearText

Specifies text for the context menu item that clears sorting settings for a column.

Type:

String

Default Value: 'Clear Sorting'

descendingText

Specifies text for the context menu item that sets a descending sort order in a column.

Type:

String

Default Value: 'Sort Descending'

mode

Specifies the sorting mode.

Type:

String

Default Value: 'single'
Accepted Values: 'multiple' | 'none' | 'single'

The following selection modes are available in the widget:

  • Single
    Rows can be sorted by values of a single column only.

  • Multiple
    Rows can be sorted by values of several columns.

When using the widget as an ASP.NET MVC Control, specify this option using the GridSortingMode enum. This enum accepts the following values: Single, Multiple and None.