TcxFilterCriteria.FilterCaption Property

Returns the filter expression‘s display text.

Declaration

property FilterCaption: string read;

Property Value

Type	Description
string	The Filter expression‘s display text.

Remarks

Use the FilterText or FilterCaption property to return filter criteria as an expression string or display text, respectively.

Tip

To define filter criteria, use AddItem, AddExpressionItem, Root, and other related API members.

Filter Expression Examples

Property	Value
FilterText	'(State = 'CA') AND (PurchaseDate = '01-Mar-1976')'
FilterCaption[1]	'(State = CA) AND (PurchaseDate = 01-Mar-1976)'
FilterCaption[2]	'(State Equals CA) AND (PurchaseDate Equals 01-Mar-1976)'

Footnotes

1. The Options property is set to [] (default).

2. The Options property value includes the fcoShowOperatorDescription flag.