GridViewCustomBindingArgsBase.FilterExpression Property

Gets the filter expression applied to the GridView.

Namespace: DevExpress.Web.Mvc

Assembly: DevExpress.Web.Mvc5.v23.2.dll

NuGet Package: DevExpress.Web.Mvc5

Declaration

C#

public string FilterExpression { get; protected set; }

VB.NET

Public Property FilterExpression As String

Property Value

Type	Description
String	A string value representing the applied filter criteria. An empty string, if no filtering is used.

Remarks

When implementing a method delegate of the GridViewCustomBindingGetUniqueHeaderFilterValuesHandler type, the FilterExpression property gets the GridView’s currently applied filter conditions that do not contain a filter criterion applied to the processed column specified by the GridViewCustomBindingGetUniqueHeaderFilterValuesArgs.FieldName property.

Refer to Implementation of Typed Method Delegates to learn more.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the FilterExpression property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

asp-net-mvc-grid-custom-binding-and-xpo/CS/XPCustomBindingExample/XPO/XpoBindingHandlers.cs#L24

public void GetDataRowCount(GridViewCustomBindingGetDataRowCountArgs e) {
    CriteriaOperator filter = CriteriaOperator.Parse(e.FilterExpression);
    CriteriaOperator expression = CriteriaOperator.Parse("count");

VB.NET

asp-net-mvc-grid-custom-binding-and-xpo/VB/XPCustomBindingExample/XPO/XpoBindingHandlers.vb#L24

Public Sub GetDataRowCount(ByVal e As GridViewCustomBindingGetDataRowCountArgs)
    Dim filter As CriteriaOperator = CriteriaOperator.Parse(e.FilterExpression)
    Dim expression As CriteriaOperator = CriteriaOperator.Parse("count")