FilterControl Class
Allows users to build filter criteria and apply them to controls and data sources.
Namespace: DevExpress.XtraEditors
Assembly: DevExpress.XtraEditors.v19.2.dll
Declaration
[Docking(DockingBehavior.Ask)]
[ToolboxBitmap(typeof(ToolboxIconsRootNS), "FilterControl")]
public class FilterControl :
BaseStyleControl,
IFilterControl,
IFilterControlGetModelRelated API Members
The following members return FilterControl objects:
| Library | Related API Members |
|---|---|
| Cross-Platform Class Library | FilterEditorControl.FilterControl |
| WinForms Controls | BaseFilterControlEventArgs.FilterEditor |
| FilterControlEventArgs.FilterControl | |
| FilterEditorControl.FilterControl | |
| FilterEditorControl.FilterControl |
Remarks
The FilterControl allows users to build a filter criterion and apply it to the attached control or data source.
Note
The XtraGrid demo shows the DevExpress.DataAccess.UI.FilterEditorControl that extends the FilterContol‘s functionality. The FilterEditorControl.FilterControl property provides access to the FilterContol object.
Supported Controls
The FilterControl supports the following controls, components, and data sources:
- DevExpress.XtraVerticalGrid.VGridControl
- DevExpress.XtraPivotGrid.PivotGridControl
- DevExpress.XtraEditors.Filtering.IFilteredComponent
- System.Windows.Forms.BindingSource
- System.Data.DataTable
- System.ComponentModel.IBindingListView
Note
The filter editor in the grid control and in the tree list provides similar functionality. You can also attach to them a stand-alone FilterControl.
Binding to Source Control
The SourceControl property specifies the data control or data source to which the FilterControl is attached.
When the filter criteria changes in the source control (for example, by the user or in code), the FilterControl automatically reflects the changes.
Filter Criteria
The FilterCriteria property gets or sets the CriteriaOperator object that specifies the filter criteria. The FilterString property specifies the string expression that corresponds to the filter criteria. See Criteria Language Syntax for more information.
When the filter criteria changes, the FilterControl does not automatically apply it to the source control. Call the ApplyFilter() method to apply the filter criteria. To clear the filter criteria and apply it, call the ClearFilter() method.
If the ReadOnly option is enabled, users cannot edit filter criteria. You can still edit the filter criteria in code.
Visual and Text Criteria Display Style
In Visual edit mode, the static (Shared in VB) WindowsFormsSettings.FilterCriteriaDisplayStyle property specifies whether to enable the Visual or Text criteria display style.
Pop-up Menu or Combo Box to Edit Operators and Operands
The UseMenuForOperandsAndOperators property specifies whether to use a pop-up menu or a combo box to edit operators and operands. The combo box displays a search box in the drop-down list and the vertical scroll bar (when the item count exceeds the list’s capacity).
Unbound Mode
You can also use the FilterControl even if it is not bound to a source control (the SourceControl property equals null). Users can build filter criteria that you can get from the FilterCriteria or FilterString property. In unbound mode, populate the FilterColumns collection with columns by which data should be filtered (this collection is populated automatically in bound mode).