DashboardConfigurator.ConnectionError Event

Allows overriding the default behavior when current connection parameters do not allow connecting to a data store.

Namespace: DevExpress.DashboardWeb

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

Declaration

public event ConnectionErrorWebEventHandler ConnectionError
Public Event ConnectionError As ConnectionErrorWebEventHandler

Event Data

The ConnectionError event handler receives an argument of the ConnectionErrorWebEventArgs type. 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.
ConnectionParameters Gets or sets parameters used to establish a connection to data.
DashboardId Gets the dashboard identifier.
DataSourceName Gets the data source name.
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

Important

To learn how to use the DashboardConfigurator's API, see the Server-Side API Overview topic.

The ConnectionError event is fired when current connection parameters do not allow connecting to a data store (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:

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.

See Also