Skip to main content

Dashboard.ConnectionError Event

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

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v22.2.Core.dll

NuGet Packages: DevExpress.Dashboard.Core, DevExpress.Win.Dashboard.Design


public event DashboardConnectionErrorEventHandler ConnectionError

Event Data

The ConnectionError event's data class is DashboardConnectionErrorEventArgs. 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.
DataSourceName Gets the data source name for which the event was raised.
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.

The event data class exposes the following methods:

Method Description
CloseWaitForm() Closes the wait form.
ShowWaitForm() Shows the wait form.


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