CustomFilterExpressionEventArgs Class

Provides data for the CustomFilterExpression events.

Namespace: DevExpress.DataAccess

Assembly: DevExpress.DataAccess.v18.1.dll

Declaration

C#

public class CustomFilterExpressionEventArgs :
    EventArgs

VB.NET

Public Class CustomFilterExpressionEventArgs
    Inherits EventArgs

Related API Members

CustomFilterExpressionEventArgs is the data class for the following events:

Library	Related API Members
WinForms Controls	SnapDocument.CustomFilterExpression
Dashboard	DashboardDesigner.CustomFilterExpression
	DashboardViewer.CustomFilterExpression

Remarks

The CustomFilterExpressionEventArgs class provides data for CustomFilterExpression events (for instance, DashboardDesigner.CustomFilterExpression or DashboardViewer.CustomFilterExpression).

These events are fired when the control sends a query to reload data from the server. Use the event parameter’s CustomFilterExpressionEventArgs.FilterExpression property to specify a filter expression to be included into this query as a WHERE clause.

Related GitHub Examples

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

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#

how-to-filter-an-sql-query-at-runtime-in-the-winforms-viewer-t339417/CS/Dashboard_CustomFilterExpression_Win/Form1.cs#L12

private void dashboardViewer1_CustomFilterExpression(object sender, CustomFilterExpressionEventArgs e) {
    if (e.DataSourceName == "SQL Data Source 1" && e.TableName == "Invoices") {

VB.NET

how-to-filter-an-sql-query-at-runtime-in-the-winforms-viewer-t339417/VB/Dashboard_CustomFilterExpression_Win/Form1.vb#L15

Private Sub dashboardViewer1_CustomFilterExpression(ByVal sender As Object,
                                                    ByVal e As CustomFilterExpressionEventArgs) _
                                                Handles dashboardViewer1.CustomFilterExpression

Inheritance

Object

EventArgs

CustomFilterExpressionEventArgs

CustomFilterExpressionWebEventArgs