Filter Panel
- 2 minutes to read
The built-in filter panel (also called filter box), available in the ExpressQuantumGrid, ExpressQuantumTreeList, and ExpressVerticalGrid controls allows end-users to customize, temporarily disable, and reapply recently used filter criteria.
UI Elements
The panel includes the currently applied filter criteria (the current filter for short) and control buttons that provide filter management capabilities.
The ExpressQuantumGrid, ExpressQuantumTreeList, and ExpressVerticalGrid controls provide a set of members that allow you to customize the following panel attributes:
Attribute | ExpressQuantumGrid | ExpressQuantumTreeList | ExpressVerticalGrid |
|---|---|---|---|
Display and behavior options | The grid View’s FilterBox property. | The tree list’s FilterBox property. | The vertical grid’s FilterBox property. |
Content | The filter string is built automatically based on the current filter. If it does not include any filter condition, the panel displays the localizable ‘<Filter is Empty>’ string (see below). | ||
Use the grid View’s FilterBox.CustomizeDialog property to switch the Customize… button’s visibility. | Use the control’s FilterBox.CustomizeDialog property to switch the Customize… button’s visibility. | ||
You can set the panel to maintain a list of most recently used filters (an MRU list) and allow end-users to reapply any of them to the control by selecting a corresponding list entry. The panel displays the filter MRU list button to provide access to the list if it includes two or more entries. End-users can click this button or the current filter to display the filter dropdown populated with list elements. Set the following property to True to enable the MRU list: | |||
The grid View’s Filtering.MRUItemsList property. | The control’s FilterBox.MRUItemsList property. | ||
Appearance | The grid View’s BackgroundBitmaps.FilterBox and Styles.FilterBox properties. | The control’s Styles.FilterBox property. | |
Localization | Use the following resource strings to localize the Customize… button’s caption and the ‘<Filter is Empty>’ string that is displayed when the panel does not include any filter condition: | ||
scxGridFilterCustomizeButtonCaption scxGridFilterIsEmpty | scxTreeListFilterCustomizeButtonCaption scxTreeListFilterIsEmpty | cxSvgFilterCustomizeButtonCaption cxSvgFilterIsEmpty | |