DashboardExporter.ConnectionError Event

Allows you to detect an error when connection parameters do not allow you to connect to a data store.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v24.1.Core.dll

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public event DashboardExporterConnectionErrorEventHandler ConnectionError

VB.NET

Public Event ConnectionError As DashboardExporterConnectionErrorEventHandler

Event Data

The ConnectionError event's data class is DashboardExporterConnectionErrorEventArgs. 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’s name for which the event is 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.

Remarks

The following code snippet handles the ConnectionError event to detect and display errors when current connection parameters do not allow you to connect to a data store:

"The following error occurs in {e.DataSourceName}: {e.Exception.Message}"

Program.cs

using DevExpress.DashboardCommon;

namespace DashboardExporterApp {
    class Program {
      //...
        DashboardExporter exporter = new DashboardExporter();
          exporter.ConnectionError += Exporter_ConnectionError;
        //...
           static void Exporter_ConnectionError(object sender, 
           DashboardExporterConnectionErrorEventArgs e) {
            Console.WriteLine(
              $"The following error occurs in {e.DataSourceName}: {e.Exception.Message}");
        }
    }
}

Program.vb

Namespace DashboardExporterApp
    Friend Class Program
      '...
        Private exporter As New DashboardExporter()
          Private exporter.ConnectionError += AddressOf Exporter_ConnectionError
        '...
           Private Shared Sub Exporter_ConnectionError(ByVal sender As Object, ByVal e As DashboardExporterConnectionErrorEventArgs)
            Console.WriteLine($"The following error occurs in {e.DataSourceName}: {e.Exception.Message}")
           End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ConnectionError event.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

bi-dashboard-mailkit-export-console-app/CS/ConsoleMailExport/Program.cs#L93

DashboardExporter exporter = new DashboardExporter();
exporter.ConnectionError += Exporter_ConnectionError;
exporter.DashboardItemDataLoadingError += Exporter_DashboardItemDataLoadingError;

bi-dashboard-mailkit-export/CS/SimpleMailExport/Form1.cs#L17

DashboardExporter exporter = new DashboardExporter();
exporter.ConnectionError += Exporter_ConnectionError;
exporter.DashboardItemDataLoadingError += Exporter_DashboardItemDataLoadingError;

VB.NET

bi-dashboard-mailkit-export-console-app/VB/ConsoleMailExport/Program.vb#L83

Dim exporter As DashboardExporter = New DashboardExporter()
AddHandler exporter.ConnectionError, AddressOf Exporter_ConnectionError
AddHandler exporter.DashboardItemDataLoadingError, AddressOf Exporter_DashboardItemDataLoadingError

bi-dashboard-mailkit-export/VB/SimpleMailExport/Form1.vb#L21

Dim exporter As DashboardExporter = New DashboardExporter()
AddHandler exporter.ConnectionError, AddressOf Exporter_ConnectionError
AddHandler exporter.DashboardItemDataLoadingError, AddressOf Exporter_DashboardItemDataLoadingError