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.2.Core.dll
NuGet Package: DevExpress.Dashboard.Core
#Declaration
public event DashboardConfigureDataConnectionEventHandler ConfigureDataConnection
#Event Data
The ConfigureDataConnection event's data class is DashboardConfigureDataConnectionEventArgs. The following properties provide information specific to this event:
Property | Description |
---|---|
Connection |
Gets the name of the connection for which the event has been raised.
Inherited from Configure |
Connection |
Gets or sets parameters used to establish a connection to data.
Inherited from Configure |
Data |
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 |
---|---|
The Sql To specify other data provider parameters, cast an object to any of the types listed in the DevExpress.
You can also add a custom connection string. Cast an object to the Custom Tip You can use a custom connection string to get data from an XML file that contains valid schema, for example, “xpoprovider=In | |
Cast an object to the Olap | |
Cast an object to the Excel | |
Cast an object to the Extract | |
Event does not occur. | |
Event does not occur. Handle the Data
| |
Cast an object to the Json You can also add a custom connection string. Cast an object to the Custom | |
Cast an object to the Mongo |
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 Dashboard