CustomFilterExpressionWebEventArgs Class

Provides data for the CustomFilterExpression events.

Assembly: DevExpress.Dashboard.v18.2.Web.dll

Declaration

C#
VB.NET

public class CustomFilterExpressionWebEventArgs :
    CustomFilterExpressionEventArgs

Public Class CustomFilterExpressionWebEventArgs
    Inherits CustomFilterExpressionEventArgs

CustomFilterExpressionWebEventArgs is the data class for the following events:

Remarks

The CustomFilterExpression events are fired when the control sends a query to reload data from the server and allow you to include WHERE clauses in SQL queries. To learn more, see the following topics.

Example

The following example shows how to filter an SQL query at runtime using the ASPxDashboardViewer.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-web-viewer-t339424.

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

<%@ Register Assembly="DevExpress.Dashboard.v15.2.Web, Version=15.2.4.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>
        <dx:ASPxDashboardViewer ID="ASPxDashboardViewer1" runat="server" Height="800px" Width="1200px"
            onconfiguredataconnection="ASPxDashboardViewer1_ConfigureDataConnection" 
            oncustomfilterexpression="ASPxDashboardViewer1_CustomFilterExpression" 
            DashboardSource="~/App_Data/Dashboard.xml">
        </dx:ASPxDashboardViewer>
    </div>
    </form>
</body>
</html>

Imports System
Imports DevExpress.DashboardWeb
Imports DevExpress.Data.Filtering
Imports DevExpress.DataAccess.ConnectionParameters

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

        Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
        End Sub

        Protected Sub ASPxDashboardViewer1_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

        Protected Sub ASPxDashboardViewer1_ConfigureDataConnection(ByVal sender As Object,
                                                                   ByVal e As ConfigureDataConnectionWebEventArgs)
            If e.DataSourceName = "SQL Data Source 1" Then
                Dim parameters As Access97ConnectionParameters = CType(e.ConnectionParameters, Access97ConnectionParameters)
                Dim databasePath As String = Server.MapPath("App_Data/nwind.mdb")
                parameters.FileName = databasePath
            End If
        End Sub
    End Class
End Namespace

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

<%@ Register Assembly="DevExpress.Dashboard.v15.2.Web, Version=15.2.4.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>
        <dx:ASPxDashboardViewer ID="ASPxDashboardViewer1" runat="server" Height="800px" Width="1200px"
            onconfiguredataconnection="ASPxDashboardViewer1_ConfigureDataConnection" 
            oncustomfilterexpression="ASPxDashboardViewer1_CustomFilterExpression" 
            DashboardSource="~/App_Data/Dashboard.xml">
        </dx:ASPxDashboardViewer>
    </div>
    </form>
</body>
</html>

using System;
using DevExpress.DashboardWeb;
using DevExpress.Data.Filtering;
using DevExpress.DataAccess.ConnectionParameters;

namespace Dashboard_CustomFilterExpression_Web {
    public partial class WebForm1 : System.Web.UI.Page {
        protected void Page_Load(object sender, EventArgs e) {
        }

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

        protected void ASPxDashboardViewer1_ConfigureDataConnection(object sender, ConfigureDataConnectionWebEventArgs e) {
            if (e.DataSourceName == "SQL Data Source 1") {
                Access97ConnectionParameters parameters = (Access97ConnectionParameters)e.ConnectionParameters;
                string databasePath = Server.MapPath("App_Data/nwind.mdb");
                parameters.FileName = databasePath;
            }
        }
    }
}

Inheritance

Object

EventArgs

CustomFilterExpressionEventArgs

CustomFilterExpressionWebEventArgs

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

CustomFilterExpressionWebEventArgs Class

Declaration

Remarks

Example

Inheritance

CustomFilterExpressionWebEventArgs Class

Declaration

Related API Members

Remarks

Example

Inheritance