Skip to main content

TcxFilterCriteria.FilterCaption Property

Returns the filter expression‘s display text.

Declaration

property FilterCaption: string read;

Property Value

Type Description
string

Filter expression‘s display text.

Remarks

The FilterCaption property returns the current filter expression displayed in the filter status bar. Use the FilterText property to specify filter criteria (as an expression string).

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.

See Also