General Information

.NET Subscription

Overview

Common Tools

Project Converter

Assembly Deployment Tool

Localization Service

Desktop

Controls

WinForms

WPF

VCL

UWP (Windows 10)

Tools

WinForms Skin Editor

WPF Theme Designer

WPF Theme Editor (Legacy)

Coded UI Test Extension

Web

Enterprise and Analytic Tools

Reporting

Report and Dashboard Server

Dashboard

Office File API

Quality Assurance and Productivity

CodeRush

CodeRush Classic

TestCafe Studio

Logify

Frameworks and Libraries

eXpressApp Framework (XAF)

eXpress Persistent Objects (XPO)

XPO Profiler

Core Libraries

Mobile

UI Controls for Xamarin.Forms

Charts for iOS / Xamarin.iOS

Charts for Android / Xamarin.Android

Grid for Xamarin.Forms (Legacy)

End-User Documentation

Interface Elements for Desktop

Interface Elements for Web

Dashboard for Desktop

Dashboard for Web

ASPxDashboard.CustomFilterExpression Event

Allows you to include WHERE clauses into DashboardSqlDataSource queries.

Namespace: DevExpress.DashboardWeb

Assembly: DevExpress.Dashboard.v19.2.Web.WebForms.dll

public event CustomFilterExpressionWebEventHandler CustomFilterExpression

Public Event CustomFilterExpression As CustomFilterExpressionWebEventHandler

Event Data

The CustomFilterExpression event handler receives an argument of the CustomFilterExpressionWebEventArgs type. The following properties provide information specific to this event.

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

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.

Examples

The following example shows how to filter an SQL query at runtime using the ASPxDashboard.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/aspxdashboard-how-to-filter-an-sql-query-at-runtime-t479085.

<%@ Page Language="vb" AutoEventWireup="true" CodeBehind="WebForm1.aspx.vb" 
         Inherits="ASPxDashboard_CustomFilterExpression.WebForm1" %>

<%@ Register Assembly="DevExpress.Dashboard.v17.1.Web, Version=17.1.8.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a"
    Namespace="DevExpress.DashboardWeb" TagPrefix="dx" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title></title>
</head>
<body>
    <form id="form1" runat="server">
    <div style="position: absolute; top: 0; left: 0; right: 0; bottom: 0;">
        <dx:ASPxDashboard ID="ASPxDashboard1" runat="server" Width="100%" Height="100%" 
            oncustomfilterexpression="ASPxDashboard1_CustomFilterExpression" 
            WorkingMode="Viewer">
        </dx:ASPxDashboard>
    </div>
    </form>
</body>
</html>

Imports System
Imports DevExpress.DashboardWeb
Imports DevExpress.Data.Filtering
Imports DevExpress.DashboardCommon

Namespace ASPxDashboard_CustomFilterExpression
    Partial Public Class WebForm1
        Inherits System.Web.UI.Page

        Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
            ASPxDashboard1.SetDashboardStorage(New DashboardFileStorage("~/App_Data/Dashboards"))
        End Sub

        Protected Sub ASPxDashboard1_CustomFilterExpression(ByVal sender As Object, _
                                                            ByVal e As CustomFilterExpressionWebEventArgs)
            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

<%@ Page Language="C#" AutoEventWireup="true" CodeBehind="WebForm1.aspx.cs" 
         Inherits="ASPxDashboard_CustomFilterExpression.WebForm1" %>

<%@ Register Assembly="DevExpress.Dashboard.v17.1.Web, Version=17.1.8.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a"
    Namespace="DevExpress.DashboardWeb" TagPrefix="dx" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title></title>
</head>
<body>
    <form id="form1" runat="server">
    <div style="position: absolute; top: 0; left: 0; right: 0; bottom: 0;">
        <dx:ASPxDashboard ID="ASPxDashboard1" runat="server" Width="100%" Height="100%" 
            oncustomfilterexpression="ASPxDashboard1_CustomFilterExpression" 
            WorkingMode="Viewer">
        </dx:ASPxDashboard>
    </div>
    </form>
</body>
</html>

using System;
using DevExpress.DashboardWeb;
using DevExpress.Data.Filtering;
using DevExpress.DashboardCommon;

namespace ASPxDashboard_CustomFilterExpression {
    public partial class WebForm1 : System.Web.UI.Page {
        protected void Page_Load(object sender, EventArgs e) {
            ASPxDashboard1.SetDashboardStorage(new DashboardFileStorage("~/App_Data/Dashboards"));
        }

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

General Information

.NET Subscription

Common Tools

Desktop

Controls

Tools

Web

Controls and Extensions

Tools

Maintenance Mode

Enterprise and Analytic Tools

Quality Assurance and Productivity

Frameworks and Libraries

Mobile

End-User Documentation

General Information

.NET Subscription

Common Tools

Desktop

Controls

Tools

Web

Controls and Extensions

Tools

Maintenance Mode

Enterprise and Analytic Tools

Quality Assurance and Productivity

Frameworks and Libraries

Mobile

End-User Documentation

ASPxDashboard.CustomFilterExpression Event

Declaration

Event Data

Remarks

NOTE

Examples

NOTE