Filter Control Elements

• Jul 28, 2021
• 3 minutes to read

This topic describes the visible ASPxFilterControl elements. Each section contains a screenshot and a brief overview of the element’s function.

The following visual elements are available.

• Tab
• Combining Operator
• Filter Condition
• Add Button

Tab

ASPxFilterControl allows users to create filter criteria. To do this, they can use visual elements (the Visual tab) or type criteria as text (the Text tab). The content of the tabs is automatically synchronized.

Note

The Text tab is not displayed by default.

The table below lists the main members that affect element appearance and functionality.

Characteristics	Members
Text tab visibility	ASPxFilterControlBase.ViewMode
Text	ASPxFilterControlBase.TextTabText, ASPxFilterControlBase.VisualTabText
Appearance	FilterControlStyles.Tab, FilterControlStyles.ActiveTab, FilterControlStyles.TabContent

Combining Operator

The Combining Operator combines filter conditions and groups of filter conditions.

You can use the FilterControlStyles.GroupType property to customize the Combining Operator style settings.

Users can click the Combining Operator to invoke the dropdown menu that allows them to change the combining operator: add a nested group or a filter condition, or remove the group.

The table below lists the main members that affect appearance and functionality of operators in the dropdown menu.

Operators	Visibility	Image	Localization
And	FilterControlGroupOperationsVisibility.And	FilterControlImages.GroupTypeAnd	ASPxEditorsStringId.FilterControl_GroupType
Or	FilterControlGroupOperationsVisibility.Or	FilterControlImages.GroupTypeOr	ASPxEditorsStringId.FilterControl_GroupType
Not And	FilterControlGroupOperationsVisibility.NotAnd	FilterControlImages.GroupTypeNotAnd	ASPxEditorsStringId.FilterControl_GroupType
Not Or	FilterControlGroupOperationsVisibility.NotOr	FilterControlImages.GroupTypeNotOr	ASPxEditorsStringId.FilterControl_GroupType
Add Group	FilterControlGroupOperationsVisibility.AddGroup	FilterControlImages.AddGroup	ASPxEditorsStringId.FilterControl_AddGroup
Add Condition	FilterControlGroupOperationsVisibility.AddCondition	FilterControlImages.AddCondition	ASPxEditorsStringId.FilterControl_AddCondition
Remove	FilterControlGroupOperationsVisibility.Remove	FilterControlImages.RemoveGroup	ASPxEditorsStringId.FilterControl_Remove

Filter Condition

A Filter Condition is a single filter criterion in the ASPxFilterControl.

The Filter Condition can contain the following elements.

• Field Name
• Comparison Operator
• Criteria Value
• Operand Type Button
• Remove Button

Field Name

A Field Name is a part of a filter condition that displays the name of the field to which the filter condition is applied.

Users can click a Field Name to invoke the dropdown menu that allows them to select another field.

The table below lists the main members that affect element appearance and functionality.

Characteristics	Members
Appearance	FilterControlStyles.PropertyName
Column Field Name	FilterControlColumn.DisplayName

Comparison Operator

A Comparison Operator is a part of a filter condition that allows users to select the applied logical operator.

Users can click a Comparison Operator to invoke a dropdown menu that allows them to change the logical operator.

The table below lists the main members that affect element appearance and functionality.

Characteristics	Members
Appearance	FilterControlStyles.Operation
Images	ASPxFilterControl.Images
Localization	ASPxEditorsStringId.FilterControl_ClauseType

Criteria Value

The Criteria Value is part of a filter condition that allows users to specify a condition’s comparison value.

Users can click the Criteria Value to edit it.

Use the FilterControlStyles.Value property to customize the Criteria Value style settings.

Buttons

The Add Button allows users to add a new filter condition to a group. Users can use the Remove Button to remove a filter condition.

The Operand Type Button allows users to switch between two modes in the following situations:

• To compare a field’s value to a value;

• To compare a field’s value to another field’s value.

The table below lists the main members that affect element appearance and functionality.

Characteristics	Add Button	Remove Button	Operand Type Button
Image	FilterControlImages.AddButton, FilterControlImages.AddButtonHot	FilterControlImages.RemoveButton, FilterControlImages.RemoveButtonHot	FilterControlImages.OperandButtonField, FilterControlImages.OperandButtonFieldHot, FilterControlImages.OperandButtonValue, FilterControlImages.OperandButtonValueHot
Style	FilterControlStyles.ImageButton	FilterControlStyles.ImageButton	FilterControlStyles.ImageButton
Visibility	no	no	ASPxFilterControlBase.ShowOperandTypeButton