Dashboard.ConfigureDataConnection Event

Allows you to customize connection settings before the connection to a data store (database, OLAP cube, etc.) is established.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public event DashboardConfigureDataConnectionEventHandler ConfigureDataConnection

VB.NET

Public Event ConfigureDataConnection As DashboardConfigureDataConnectionEventHandler

Event Data

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

Property	Description
ConnectionName	Gets the name of the connection for which the event has been raised. Inherited from ConfigureDataConnectionEventArgs.
ConnectionParameters	Gets or sets parameters used to establish a connection to data. Inherited from ConfigureDataConnectionEventArgs.
DataSourceName	Gets the data source name for which the event was raised.

Remarks

The ConfigureDataConnection event is raised before the connection to a data store is established and allows you to customize connection settings.

To specify connection parameters, cast an object the e.ConnectionParameters property returns to the DataConnectionParametersBase descendant. The following table lists the different data sources and their corresponding descendants:

Data Source	Parameter Type
SQL Data Source	The SqlServerConnectionParametersBase class is the base type and defines the basic connection parameters: DatabaseName, Password, ServerName and UserName. To specify other data provider parameters, cast an object to any of the types listed in the DevExpress.DataAccess.ConnectionParameters namespace. Here are some of the types: Access2007ConnectionParameters AmazonRedshiftConnectionParameters TeradataConnectionParameters PostgreSqlConnectionParameters MsSqlConnectionParameters MySqlConnectionParameters PervasiveSqlConnectionParameters VistaDB5ConnectionParameters You can also add a custom connection string. Cast an object to the CustomStringConnectionParameters class and assign a custom connection string to the ConnectionString property. Tip You can use a custom connection string to get data from an XML file that contains valid schema, for example, “xpoprovider=InMemoryDataStore;data source=””your_data_file.xml””;read only=True”
OLAP Data Source	Cast an object to the OlapConnectionParameters type and use the ConnectionString property.
Excel Data Source	Cast an object to the ExcelDataSourceConnectionParameters type and use the FileName and Password properties.
Extract Data Source	Cast an object to the ExtractDataSourceConnectionParameters type and use the FileName and DriverName properties.
Entity Framework Data Source	Event does not occur.
Object Data Source	Event does not occur. Handle the DataLoading/AsyncDataLoading event instead: ASPxDashboard.DataLoading DashboardConfigurator.DataLoading DashboardControl.AsyncDataLoading IDashboardControl.AsyncDataLoading IDashboardControl.DataLoading DashboardDesigner.DataLoading DashboardDesigner.AsyncDataLoading DashboardViewer.DataLoading DashboardViewer.AsyncDataLoading Dashboard.DataLoading
JSON Data Source	Cast an object to the JsonSourceConnectionParameters type and use the JsonSource property. You can also add a custom connection string. Cast an object to the CustomStringConnectionParameters class and assign a custom connection string to the ConnectionString property.
MongoDB Data Source	Cast an object to the MongoDBCustomConnectionParameters type and use the following connection parameters: MongoDBConnectionParameters.Hostname MongoDBConnectionParameters.Port MongoDBConnectionParameters.IsSRVRecord MongoDBConnectionParameters.AuthenticationInfo

Tip

Refer to the following topic for information about custom connection strings: Custom Connection Strings for Data Sources

This event is raised when the dashboard is supplied with data using one of the following data source types:

• DashboardSqlDataSource
• DashboardOlapDataSource
• DashboardExcelDataSource
• DashboardExtractDataSource
• DashboardJsonDataSource
• DashboardMongoDBDataSource

Note

If the dashboard is supplied with data using the DashboardObjectDataSource data source, the Dashboard.DataLoading event is fired instead.