[Overview][Constants][Types][Classes][Procedures and functions][Index] | Reference for unit 'EditBtn' (#lcl)

# TCustomControlFilterEdit.Filter

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

## Declaration

Source position: editbtn.pas line 280

`public property TCustomControlFilterEdit.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.

## Version info

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

## See also

TCustomControlFilterEdit.Text |  | String with the text or caption for the control.
TCustomControlFilterEdit.FilterLowercase |  | The textual representation for the Filter using lowercase characters.
TCustomControlFilterEdit.InternalSetFilter |  | Performs actions needed when a new value is assigned to the Filter property.
TCustomControlFilterEdit.FilterOptions |  | Contains options which control string comparisons using the Filter for the control.
TCustomControlFilterEdit.ForceFilter |  | Applies a new Filter immediately without waiting for an idle state.
TCustomControlFilterEdit.DoDefaultFilterItem |  | Provides a default routine used to examine an item in the filtered edit control.
TCustomControlFilterEdit.OnFilterItem |  | An event handler to give extra conditions for filtering, in addition to the default behavior. Returns True if the passes the filter.
TCustomControlFilterEdit.OnFilterItemEx |  | Event handler signalled to filter data in the control using its caption or item data.
TCustomControlFilterEdit.EditChange |  | Performs actions needed when the Edit for the control is changed.