JVCL Help:TJvCustomDBTreeView.UseFilter

From Project JEDI Wiki
Jump to navigationJump to search
JEDI Visual Component Library Help

Search in JVCL Help

 
Search in all projects
 

Summary

Indicates if a filter should be use on the dataset when building the tree structure in the data-aware tree view.


Pascal

 propertyUseFilter: Boolean;


Description

UseFilter is a Boolean property that indicates if a filter on the underlying dataset for the DataSource can be used when building the tree structure in the data-aware tree view.
Setting UseFilter to True indicates that the underlying TDataSet should use a filter when building child nodes for the current node in the tree view. The filter will consist of a statement that compares the current value in MasterField to values found in DetailField. An existing filter expression for the dataset is retained, and any new content for the expression is appended using a logical AND to support both conditions. The filter is enabled prior to scanning the dataset for rows having a value in DetailField that matches the current value of MasterField.
When UseFilter contains False, data in the underlying dataset must already be ordered to produce the desired tree structure based on values in MasterField and DetailField.
Do not set UseFilter to True if the dataset does not support use of filters expressions.
UseFilter is used in the RefreshChild method when building and displaying nodes in the tree structure.


About

Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page