Sign in Join
FPDoc Onlineexperiment

TCustomControlFilterEdit.Filter property

Member of TCustomControlFilterEditpublicIn unit EditBtn

Contains the textual used to select the visible items in the associated control.

Declaration

pascal
property Filter: string read fFilter write SetFilter;

Description

Filter is a String property which contains the value used to filter the items in an associated control. Filter is used when the SortAndFilter and ApplyFilterCore methods (in descendent classes) are called to apply the filter value to the items in an associated control.

Changing the value for the property causes the value in the Text property control to be updated. The InternalSetFilter method is called to perform actions needed for the new property value. The new filter will be applied to the associated Control when the OnChange handler for the Edit control is called.

Use FilterLowercase to access the Filter value converted to lowercase UTF-8 characters.

Use FilterOptions to indicate whether case sensitivity is enabled for the filter value; FilterLowercase is used when fsoCaseSensitive has not been included in the set of options.

Use ResetFilter to clear the filter value (and the Text property) for the control. Use ForceFilter to immediately apply a specified Filter value to the items in the associated Control.

Modified in LCL version 3.0 to call InternalSetFilter when a new value is assigned to the property.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.