ListCaptions.SortChanging

Syntax

SortChanging: function(sender, args);

Parameters

sender. Event source.

args. Event information:

Caption. Number. Sorting column index.
Direction. String. Sorting direction.
Method. String. Sorting method.
Cancel. Boolean. If this property is set to true in the event handler, the operation is not executed.

Description

The SortChanging event occurs before changing sorting.

Example

Executing the example requires the SimpleTreeList component with the Tree identifier (see Example of Creating the SimpleTreeList Component).

// Get title
caps = Tree.getCaptions();
// Set event
caps.SortChanging.add( function(sender, args) {
  console.log("SortChanging event:");
  console.log(args);
});
// Initialize event by changing column sorting with mouse

After executing the example the SortChanging event is added.