Skip to main content

TcxFilterCriteriaItemList Class

A list of filter conditions combined by a logical operator.

Declaration

TcxFilterCriteriaItemList = class(
    TcxCustomFilterCriteriaItem
)

Remarks

The TcxFilterCriteriaItemList represents a list of filter conditions combined by one logical operator. Conditions are accessible via the Items property and the logical operator is defined by the BoolOperatorKind property. Conditions can be of two types:

  • A simple condition consisting of a single comparison (for instance “ > 12”, “ = ‘VISA’ “, “ LIKE ‘Mc%’ “, etc.) The TcxFilterCriteriaItem class represents a single condition.

  • An aggregate condition, which specifies a list of simple (or aggregate) conditions combined by one logical operator. The TcxFilterCriteriaItemList class represents an aggregate condition.

Two lists are constructed for the following filter criteria:

(CustNo < 1000) AND ((Name LIKE ‘A%’) OR (Name LIKE ‘Z%’))

The first list combines two simple conditions (Name LIKE ‘A%’) and (Name LIKE ‘Z%’) with the OR operator. The second list combines a simple condition (CustNo < 1000) and the aggregate condition provided by the first list with the AND operator. The second list is called the root list.

To add a simple condition to the filter criteria list you can use the AddItem method. To add an aggregate condition to the criteria list use the AddItemList method.

Both the TcxFilterCriteriaItemList and TcxFilterCriteriaItem classes are derived from one base class – TcxCustomFilterCriteriaItem.

Filter criteria for a grid control are defined by the TcxFilterCriteria class. It provides the TcxFilterCriteria.Root property of the TcxFilterCriteriaItemList type, which you use to construct the filter conditions.

Inheritance

TObject
TcxCustomFilterCriteriaItem
TcxFilterCriteriaItemList
See Also