TreeListBase.FilterChanging

Syntax

FilterChanging: function(sender, args);

Parameters

sender. Event source.

args. Event information:

String. String. Filter string.
Column. Number. Sorted column number.
Cancel. Boolean. If this property is set to true in the event handler, filtering is not executed.

Description

The FilterChanging event occurs before filter is changed.

Example

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

// Set event
Tree.FilterChanging.add( function(sender, args) {
  console.log("FilterChanging event:");
  console.log(args);
});
// Initialize event
Tree.setFilter("node", 0);

After executing the example the FilterChanging event is added.