CustomFilterExpressionEventArgs.FilterExpression Property

Gets or sets the filter expression that defines a WHERE clause included in the SQL query.

Namespace: DevExpress.DataAccess

Assembly: DevExpress.DataAccess.v23.2.dll

NuGet Packages: DevExpress.DataAccess, DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap

Declaration

C#

public CriteriaOperator FilterExpression { get; set; }

VB.NET

Public Property FilterExpression As CriteriaOperator

Property Value

Type	Description
CriteriaOperator	A CriteriaOperator descendant that specifies the filter expression that defines a WHERE clause included in the SQL query.

Remarks

To learn how to create a filter criteria as a CriteriaOperator object, see Simplified Criteria Syntax.

To identify the data source for which the event has been raised, use the CustomFilterExpressionEventArgs.DataSourceName or CustomFilterExpressionEventArgs.DataSourceComponentName property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references 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#

web-dashboard-filter-sql-query-at-runtime/CS/ASPxDashboard_CustomFilterExpression/WebForm1.aspx.cs#L13

if (e.DataSourceConnectionName == "nwindConnection" && e.QueryName == "Invoices") {
    e.FilterExpression = new BinaryOperator("Customers.CompanyName", "Around the Horn", BinaryOperatorType.Equal);
}

winforms-dashboard-filter-sql-query-at-runtime/CS/Dashboard_CustomFilterExpression_Win/Form1.cs#L13

if (e.DataSourceName == "SQL Data Source 1" && e.TableName == "Invoices") {
    e.FilterExpression = new BinaryOperator("CustomerID","AROUT",BinaryOperatorType.Equal);
}

DashboardDifferentUserDataMVC/CS/MVCDashboard/App_Start/DashboardConfig.cs#L122

if (userName == "User") {
    e.FilterExpression = CriteriaOperator.Parse("StartsWith([CategoryName], 'c')");
}

VB.NET

web-dashboard-filter-sql-query-at-runtime/VB/ASPxDashboard_CustomFilterExpression/WebForm1.aspx.vb#L16

If Equals(e.DataSourceConnectionName, "nwindConnection") AndAlso Equals(e.QueryName, "Invoices") Then
    e.FilterExpression = New BinaryOperator("Customers.CompanyName", "Around the Horn", BinaryOperatorType.Equal)
End If

winforms-dashboard-filter-sql-query-at-runtime/VB/Dashboard_CustomFilterExpression_Win/Form1.vb#L15

If e.DataSourceName = "SQL Data Source 1" AndAlso e.TableName = "Invoices" Then
    e.FilterExpression = New BinaryOperator("CustomerID","AROUT",BinaryOperatorType.Equal)
End If