A newer version of this page is available. Switch to the current version.


  • 3 minutes to read

The ASPxFilterControl is a stand-alone control that allows end-users to build filter criteria. It does not require any SQL syntax and doesn't have any limitations regarding the complexity of the filter conditions. With the ASPxFilterControl, you can construct any number of filter expressions, combined by any logical operator, and apply them to controls or to a data source.


The ASPxFilterControl offers the following features:

  • Rich end-users capabilities

    See ASPxFilterControl: End-Users Capabilities for more information.

  • Appearance customization

    The ASPxFilterControl provides multiple styles that allow you to customize the appearance of individual elements and manage the control's overall appearance. Each style property has a number of attributes that allow you to customize element appearance to the maximum extent allowed by web browsers. These attributes include: colors, fonts, borders, text attributes, etc.

    Method Description
    FilterControlStyles.GroupType Gets the style settings that define the combining operator appearance.
    FilterControlStyles.ImageButton Gets the style settings that define the add and remove buttons appearance.
    FilterControlStyles.Operation Gets the style settings that define the comparison operator appearance.
    FilterControlStyles.PropertyName Gets the style settings that define the field name appearance.
    FilterControlStyles.Table Gets the style settings that define the filter area appearance.
    FilterControlStyles.Value Gets the style settings that define the criteria value appearance.
  • Expression Validation

    The filter expression obtained can be validated for completeness by using the IsFilterExpressionValid method, available both on the server and client sides. This method checks whether or not an end-user has entered all the required criteria values, and indicates whether or not it's safe to apply the expression. You can define validation settings for each column separately. See the Validation topic to learn more.

  • Full-featured client-side API

    ASPxFilterControl provides you with a comprehensive client-side API. This API is implemented using JavaScript and is exposed via the ASPxClientFilterControl object. The ASPxClientFilterControl object serves as a client-side equivalent of the ASPxFilterControl control.

    You can work with editor values using the following methods.

    Method Description
    ASPxClientFilterControl.Apply Applies a filter constructed by an end-user.
    ASPxClientFilterControl.GetAppliedFilterExpression Returns the applied filter expression.
    ASPxClientFilterControl.GetEditor Returns the editor used to edit operand values for the specified filter column.
    ASPxClientFilterControl.GetFilterExpression Returns the filter expression.
    ASPxClientFilterControl.IsFilterExpressionValid Returns a value indicating whether the filter expression being currently composed on the client side is valid - all expression conditions are filled.
    ASPxClientFilterControl.Reset Resets the current filter expression to a previously applied filter expression.
See Also