ConfigureDataConnectionWebEventArgs Class

Provides data for the ConfigureDataConnection events.

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

Declaration

C#
VB.NET

public class ConfigureDataConnectionWebEventArgs :
    DashboardConfigureDataConnectionEventArgs

Public Class ConfigureDataConnectionWebEventArgs
    Inherits DashboardConfigureDataConnectionEventArgs

ConfigureDataConnectionWebEventArgs is the data class for the following events:

Remarks

The ConfigureDataConnection events are raised before the connection to a database is established and allows you to customize connection settings. Handle this event to change the parameters required to establish a connection to data (for instance, the server name, the database name, user credentials, the path to a data file, etc). To learn more, see the following topics.

Example

This example demonstrates how to customize connection settings before ASPxDashboardViewer connects to a database using the ASPxDashboardViewer.ConfigureDataConnection event.

In this example, the dashboard visualizes data from the secured Microsoft Access database. To visualize data from this database file, it is necessary to provide connection parameters (a path to the database file, a user name and a password for authentication).

The FileConnectionParametersBase.FileName property specifies the path to a database file.
The Access97ConnectionParameters.UserName and FileConnectionParametersBase.Password event parameters are used to provide the user name and password respectively.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-customize-connection-settings-before-aspxdashboardviewer-connects-to-a-database-t198248.

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

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

<!DOCTYPE html>

<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" 
            onconfiguredataconnection="ASPxDashboardViewer1_ConfigureDataConnection" 
            Height="800px" Width="1200px">
        </dx:ASPxDashboardViewer>
    </div>
    </form>
</body>
</html>

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

namespace Dashboard_ConfigureDataConnection_Web {
    public partial class WebForm1 : System.Web.UI.Page {
        protected void Page_Load(object sender, EventArgs e) {
            string dashboardPath = Server.MapPath("~/App_Data/nwindDashboard.xml");
            ASPxDashboardViewer1.DashboardSource = dashboardPath;
        }

        protected void ASPxDashboardViewer1_ConfigureDataConnection(object sender, 
            ConfigureDataConnectionWebEventArgs e) {
            // Checks the name of the connection for which the event has been raised.
            if (e.DataSourceName == "SQL Data Source 1") {
                // Gets the connection parameters used to establish a connection to the database.
                Access97ConnectionParameters parameters =
                    (Access97ConnectionParameters)e.ConnectionParameters;

                // Specifies the path to a database file.
                string filePath = Server.MapPath("~/App_Data/nwind.mdb");
                parameters.FileName = filePath;

                // Specifies the user name used to access the database file. 
                parameters.UserName = "Admin";

                // Specifies the password used to access the database file.
                parameters.Password = "password";
            }
        }
    }
}

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

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

<!DOCTYPE html>

<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" 
            onconfiguredataconnection="ASPxDashboardViewer1_ConfigureDataConnection" 
            Height="800px" Width="1200px">
        </dx:ASPxDashboardViewer>
    </div>
    </form>
</body>
</html>

Imports System
Imports DevExpress.DashboardWeb
Imports DevExpress.DataAccess.ConnectionParameters

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

        Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
            Dim dashboardPath As String = Server.MapPath("~/App_Data/nwindDashboard.xml")
            ASPxDashboardViewer1.DashboardSource = dashboardPath
        End Sub

        Protected Sub ASPxDashboardViewer1_ConfigureDataConnection(ByVal sender As Object, _
                                           ByVal e As ConfigureDataConnectionWebEventArgs)
            ' Checks the name of the connection for which the event has been raised.
            If e.DataSourceName = "SQL Data Source 1" Then
                ' Gets the connection parameters used to establish a connection to the database.
                Dim parameters As Access97ConnectionParameters =
                    CType(e.ConnectionParameters, Access97ConnectionParameters)

                ' Specifies the path to a database file.
                Dim filePath As String = Server.MapPath("~/App_Data/nwind.mdb")
                parameters.FileName = filePath

                ' Specifies the user name used to access the database file. 
                parameters.UserName = "Admin"

                ' Specifies the password used to access the database file.
                parameters.Password = "password"
            End If
        End Sub
    End Class
End Namespace

Inheritance

Object

EventArgs

ConfigureDataConnectionEventArgs

DashboardConfigureDataConnectionEventArgs

ConfigureDataConnectionWebEventArgs

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

ConfigureDataConnectionWebEventArgs Class

Declaration

Remarks

Example

Inheritance

ConfigureDataConnectionWebEventArgs Class

Declaration

Related API Members

Remarks

Example

Inheritance