DashboardOlapDataSource.ConnectionError Event
Allows users to override the default behavior if connection to an OLAP cube fails with current connection parameters.
Namespace: DevExpress.DashboardCommon
Assembly: DevExpress.Dashboard.v24.1.Core.dll
NuGet Package: DevExpress.Dashboard.Core
Declaration
Event Data
The ConnectionError event's data class is ConnectionErrorEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| Cancel | Gets or sets whether the operation performed on the processed event should be canceled. |
| 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. |
| Exception | Gets an exception that caused the ConnectionError event. |
| Handled | Gets or sets whether default actions are required to connect to a data store. |
Remarks
The ConnectionError event fires if connection to an OLAP cube fails with current connection parameters (for instance, the cube is inaccessible). You can handle the ConnectionError event and override the default behavior in this case.
To override the default behavior, do the following:
- Check the connection name for which the event has been raised using the ConfigureDataConnectionEventArgs.ConnectionName event parameter.
- Provide new connection parameters using the ConfigureDataConnectionEventArgs.ConnectionParameters property.
- Set the ConnectionErrorEventArgs.Handled property to true. This will cancel the default routine for providing connection parameters.
To cancel connecting to the data store, use the ConnectionErrorEventArgs.Cancel property.
To get the exception that caused the event, use the ConnectionErrorEventArgs.Exception property.