DashboardConfigureDataConnectionEventArgs Class

Provides data for ConfigureDataConnection events.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v24.1.Core.dll

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public class DashboardConfigureDataConnectionEventArgs :
    ConfigureDataConnectionEventArgs

VB.NET

Public Class DashboardConfigureDataConnectionEventArgs
    Inherits ConfigureDataConnectionEventArgs

Related API Members

DashboardConfigureDataConnectionEventArgs is the data class for the following events:

• Dashboard.ConfigureDataConnection
• DashboardControl.ConfigureDataConnection
• DashboardDesigner.ConfigureDataConnection
• DashboardExporter.ConfigureDataConnection
• DashboardViewer.ConfigureDataConnection
• IDashboardControl.ConfigureDataConnection

Remarks

ConfigureDataConnection events are raised before the connection to a database is established and allow you to customize connection settings.

• Dashboard.ConfigureDataConnection
• DashboardDesigner.ConfigureDataConnection
• DashboardViewer.ConfigureDataConnection

These events are raised when the dashboard is supplied with data using the DashboardSqlDataSource and DashboardOlapDataSource data sources (see Connect to SQL Databases and Connecting to OLAP Cubes).

Use the DashboardConfigureDataConnectionEventArgs.DataSourceName property to obtain the data source name for which the event was raised. Then, specify the required connection parameters using the ConfigureDataConnectionEventArgs.ConnectionParameters property.

Note

If the dashboard is supplied with data using the DashboardObjectDataSource data source, DataLoading events are fired instead.

Inheritance

Object

EventArgs

ConfigureDataConnectionEventArgs

DashboardConfigureDataConnectionEventArgs

ConfigureDataConnectionWebEventArgs