TreeListBase.FilterString

Syntax

FilterString: String;

Description

The FilterString property determines filter text.

Comments

Use JSON or the setFilter(string, column) method to set the property value and the getFilterColumn() method to get the property value.

If the filter is enabled, the tree displays only nodes satisfying the filter text.

Example

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

// Set filter
Tree.setFilter("Node2", 0);
// Get filtering check text
Tree.getFilterString();

After executing the example the current filter is obtained.

See also:

TreeListBase