Back to Devexpress

Filter Builder

aspnetmvc-120467-components-grid-view-data-shaping-and-manipulation-filtering-filter-builder.md

latest4.7 KB
Original Source

Filter Builder

  • Feb 02, 2023
  • 3 minutes to read

The filter builder allows end-users to build complex filter criteria with an unlimited number of filter conditions, combined by logical operators.

This topic contains the following sections:

How to Invoke the Filter Builder

Click the filter image or filter expression in the filter bar to invoke the filter builder. Set the ASPxGridSettings.ShowFilterBar property to one of the following values to show the filter bar.

  • Hidden - The filter bar is always hidden.
  • Visible - The filter bar is always visible.
  • Auto - The filter bar is shown when a user filters grid data.

You can control the filter builder’s visibility programmatically using the following methods:

ActionClient-side methodsServer-side methods
ShowASPxClientGridView.ShowFilterControlASPxGridBase.ShowFilterControl
HideASPxClientGridView.CloseFilterControlASPxGridBase.HideFilterControl

How to Specify the Filter Builder Elements Visibility

Tab Visibility

End-users can create filter criteria using the Visual tab or by typing the criteria as text ( Text tab). Set the ASPxGridFilterControlSettings.ViewMode property to VisualAndText to enable both the Text and Visual tabs. This synchronizes a tab’s content automatically.

Group Operator Visibility

Use ASPxGridFilterControlSettings.GroupOperationsVisibility property to specify the group operators’ visibility in the drop-down menu.

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 value; or comparing a field’s value to another field’s value. Use the ASPxGridFilterControlSettings.ShowOperandTypeButton property to show this button visible.

Visibility of Filter Operators

The filter control drop-down window displays different comparison operators based on the column data type. The table below lists comparison operator’s visibility for different column types.

Filter Comparison OperatorString Column[1]ComboBox ColumnBinary Image ColumnDate ColumnOther Type Column (Numbers, etc.)
Equalsyesyes (default value)noyes (default value)yes
Does not equalyesyesnoyesyes
Is greater thanyesnonoyesyes (default value)
Is greater than or equal toyesnonoyesyes
Is less thanyesnonoyesyes
Is less than or equal toyesnonoyesyes
Is betweenyesnonoyesyes
Is not betweenyesnonoyesyes
Containsyesnononono
Does not containyesnononono
Begins withyes (default value)nononono
Ends withyesnononono
Is likeyesnononono
Is not likeyesnononono
Is blankyesyesnoyesyes
Is not blankyesyesyes (default value)yesyes
Is any ofyesyesyesyesyes
Is none ofyesyesnoyesyes
Date operators[2]nononoyesno

Online Demo

GridView - Filter Builder

Footnotes

  1. A string column is a column containing string values or a column whose GridDataColumnSettings.FilterMode property is set to DisplayText.

  2. For date columns, the filter control displays an additional list of date operators.