aspnet-116149-components-vertical-grid-concepts-data-shaping-and-manipulation-filtering-filter-control.md
This topic contains the following sections.
The filter control allows end-users to build complex filter criteria with an unlimited number of filter conditions, combined by logical operators.
The filter control can be invoked by clicking the filter image or filter expression displayed in the filter bar, whose visibility is controlled by the ASPxGridSettings.ShowFilterBar property.
The ASPxGridSettings.ShowFilterBar property can be set to the following values.
You can show and hide the filter control in code using the following methods.
| Action | Client-side methods | Server-side methods |
|---|---|---|
| Show | ASPxClientVerticalGrid.ShowFilterControl | ASPxGridBase.ShowFilterControl |
| Hide | ASPxClientVerticalGrid.CloseFilterControl | ASPxGridBase.HideFilterControl |
Row Visibility
By default, the filter control allows end-users to create filter criteria with rows that are visible in the grid. Set the ASPxGridFilterControlSettings.ShowAllDataSourceColumns property to true to display all rows from the data source in the filter control (even if these rows are not visible in the grid).
The filter control can display hierarchical rows provided that the ASPxGridFilterControlSettings.AllowHierarchicalColumns property is set to true. In this case, you can use the ASPxGridFilterControlSettings.MaxHierarchyDepth property to limit the max hierarchy depth level.
Tab Visibility
End-users can create filter criteria using visual representation ( Visual tab) or by typing the criteria as text ( Text tab). The content of the tabs is automatically synchronized. Note that the Text tab is disabled by default, and the Visual tab header is not displayed. Set the ASPxGridFilterControlSettings.ViewMode property to VisualAndText to enable them.
Group Operator Visibility
You can control the visibility of group operators displayed in the drop-down menu using the ASPxGridFilterControlSettings.GroupOperationsVisibility property.
Operand Type Button Visibility
The operand type button allows end-users to switch a filter condition between two modes:
Comparing a field’s value to a specified criteria value.
Comparing fields values to each other. For example, filtering records where the “Units in stock” field value is greater than the “Units on order” one.
The button visibility is controlled by the ASPxGridFilterControlSettings.ShowOperandTypeButton property.
The filter control drop-down window displays different comparison operators based on the row data type. The table below lists comparison operator visibility for different row types.
| Filter Comparison Operator | String Row[1] | ComboBox Row | Binary Image Row | Date Row | Other Type Row(Numbers, etc.) |
|---|---|---|---|---|---|
| Equals | yes | yes (default value) | no | yes (default value) | yes |
| Does not equal | yes | yes | no | yes | yes |
| Is greater than | yes | no | no | yes | yes (default value) |
| Is greater than or equal to | yes | no | no | yes | yes |
| Is less than | yes | no | no | yes | yes |
| Is less than or equal to | yes | no | no | yes | yes |
| Is between | yes | no | no | yes | yes |
| Is not between | yes | no | no | yes | yes |
| Contains | yes | no | no | no | no |
| Does not contain | yes | no | no | no | no |
| Begins with | yes (default value) | no | no | no | no |
| Ends with | yes | no | no | no | no |
| Is like | yes | no | no | no | no |
| Is not like | yes | no | no | no | no |
| Is blank | yes | yes | no | yes | yes |
| Is not blank | yes | yes | yes (default value) | yes | yes |
| Is any of | yes | yes | yes | yes | yes |
| Is none of | yes | yes | no | yes | yes |
| Date operators[2] | no | no | no | yes | no |
Footnotes
A string row is a row containing string values or a row whose GridDataColumnSettings.FilterMode property is set to DisplayText.
For date rows, the filter control displays an additional list of date operators.
See Also