TreeListBase.SortChanging

Syntax

SortChanging: function(sender, args);

Parameters

sender. Event source.

args. Event information:

Node. String. Node key.
Column. Number. Column index.
Direction. PP.Ui.TreeSortDirection. Sorting direction.
Method. PP.Ui.TreeSortMethod. Sorting method.
Cancel. Boolean. If this property is set to true in the event handler, sorting is not changed.

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

// Set event
Tree.SortChanging.add( function(sender, args) {
  console.log("SortChanging event:");
  console.log(args);
});
// Initialize event
Tree.setSort(0, PP.Ui.TreeSortDirection.Asc, PP.Ui.TreeSortMethod.String);

After executing the example the SortChanging event is added.