When this style is set, grid columns become sortable. When the user clicks a column heading, the grid content is sorted by that column. Hold [Ctrl] to sort by multiple columns. No additional programming is needed because only the appearance is affected and the program still receives columns' information as if they were in their original positions.

The icons displayed on the heading can be customized by providing custom PNG files as described in Default icons.

The empty row produced by setting Num-Rows to "-1" is not included in the sort and is always placed at the bottom of the grid.

The sort logic depends on the Data-Types set for the column according to the following associations:

If the Data-Types is omitted, then an Alphanumeric sort is performed.

The Date/Time sort is performed according to the datetime format string. See Data-Types for date and time for details. When the format string includes words (e.g. the day or the month in the date are expressed with words) these words are searched in the US locale for type "D" and in the current locale for type "E", if they’re not found, then the result of the sort is unpredictable.

This style makes all the columns sortable. If you wish to have only some columns sortable, you should consider to use Sort-Types instead.

This style is overridden by the Sort-Types property. If both are set, the runtime behaves as if only Sort-Types was set.

 

Example - Define a grid with sortable-columns