DashboardConfigurator.ConnectionError Event

Allows users to override the default behavior if data store connection fails with current connection parameters.

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

NuGet Package : DevExpress.Web.Dashboard.Common

Declaration

C#
VB.NET

csharp

public event ConnectionErrorWebEventHandler ConnectionError

Public Event ConnectionError As ConnectionErrorWebEventHandler

Event Data

The ConnectionError event's data class is ConnectionErrorWebEventArgs. 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. Inherited from ConnectionErrorEventArgs.
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.
DashboardId	Gets the dashboard identifier.
DataSourceName	Gets the data source name.
Exception	Gets an exception that caused the ConnectionError event. Inherited from ConnectionErrorEventArgs.
Handled	Gets or sets whether default actions are required to connect to a data store. Inherited from ConnectionErrorEventArgs.

Remarks

Tip

For information on how to use the DashboardConfigurator‘s API, see the following topic: Server-Side API Overview.

The ConnectionError event fires if data store connection fails with current connection parameters (for instance, the database 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 data source name for which the event has been raised using the ConnectionErrorWebEventArgs.DataSourceName event parameter.
Provide new connection parameters using the ConfigureDataConnectionEventArgs.ConnectionParameters property.
Set the 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.