DashboardViewer.CustomFilterExpression Event

Allows you to include WHERE clauses into DashboardSqlDataSource queries.

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v19.1.Win.dll

Declaration

C#

public event CustomFilterExpressionEventHandler CustomFilterExpression

VB.NET

Public Event CustomFilterExpression As CustomFilterExpressionEventHandler

Event Data

The CustomFilterExpression event's data class is CustomFilterExpressionEventArgs. The following properties provide information specific to this event:

Property	Description
DataSourceComponentName	Get the data source name, used in code to identify the data source’s object, for which the event has been raised.
DataSourceName	Gets the name of the data source for which the event has been raised.
FilterExpression	Gets or sets the filter expression that defines a WHERE clause included in the SQL query.
QueryName	Gets the name of the query for which the event was raised.
TableName	Indicates the name of a data table to which the CustomFilterExpressionEventArgs.FilterExpression applies.

Remarks

The CustomFilterExpression event fires for each SelectQuery within DashboardSqlDataSource (the SqlDataSource.Queries property) and allows you to include a WHERE clause to a query at runtime using the CustomFilterExpressionEventArgs.FilterExpression event parameter. If filtering is already applied to the SQL query, CustomFilterExpressionEventArgs.FilterExpression returns a corresponding filter criteria.

Note

The CustomFilterExpression event is not raised for custom SQL queries and stored procedures.

Example

Note

This example demonstrates API and functionality that is common for the DashboardViewer and DashboardDesigner controls.

The following example shows how to filter an SQL query at runtime using the DashboardViewer.CustomFilterExpression event. The CustomFilterExpressionEventArgs.TableName event parameter is used to check the name of the query that should be filtered. The CustomFilterExpressionEventArgs.FilterExpression property specifies the required filter criteria.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-filter-an-sql-query-at-runtime-in-the-winforms-viewer-t339417.

Form1.cs

using DevExpress.DataAccess;
using DevExpress.Data.Filtering;

namespace Dashboard_CustomFilterExpression_Win {
    public partial class Form1 : DevExpress.XtraEditors.XtraForm {
        public Form1() {
            InitializeComponent();

            dashboardViewer1.LoadDashboard(@"..\..\Data\Dashboard.xml");
        }

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

Form1.vb

Imports DevExpress.DataAccess
Imports DevExpress.Data.Filtering

Namespace Dashboard_CustomFilterExpression_Win
    Partial Public Class Form1
        Inherits DevExpress.XtraEditors.XtraForm

        Public Sub New()
            InitializeComponent()

            dashboardViewer1.LoadDashboard("..\..\Data\Dashboard.xml")
        End Sub

        Private Sub dashboardViewer1_CustomFilterExpression(ByVal sender As Object,
                                                            ByVal e As CustomFilterExpressionEventArgs) _
                                                        Handles dashboardViewer1.CustomFilterExpression
            If e.DataSourceName = "SQL Data Source 1" AndAlso e.TableName = "Invoices" Then
                e.FilterExpression = New BinaryOperator("CustomerID", "AROUT", BinaryOperatorType.Equal)
            End If
        End Sub
    End Class
End Namespace