DashboardExporter.DataLoadingError Event

Allows you to detect errors that occurred while a dashboard loaded data.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public event DataLoadingErrorEventHandler DataLoadingError

VB.NET

Public Event DataLoadingError As DataLoadingErrorEventHandler

Event Data

The DataLoadingError event's data class is DataLoadingErrorEventArgs. The following properties provide information specific to this event:

Property	Description
Errors	Gets errors that occur during data loading.
Handled	Gets or sets whether default actions are required when data loading errors occur.

Remarks

The following code snippet handles the DataLoadingError event to detect and display errors that occurred while a dashboard loaded data:

Program.cs

using DevExpress.DashboardCommon;

namespace DashboardExporterApp {
    class Program {
      //...
        DashboardExporter exporter = new DashboardExporter();
         exporter.DataLoadingError += Exporter_DataLoadingError;
        //...
         static void Exporter_DataLoadingError(object sender, 
         DataLoadingErrorEventArgs e) {
            foreach(DataLoadingError error in e.Errors)
                Console.WriteLine(
                  $"The following error occurs in {error.DataSourceName}: {error.Error}");
        }
    }
}

Program.vb

Imports DevExpress.DashboardCommon

Namespace DashboardExporterApp
    Friend Class Program
      '...
        Private exporter As New DashboardExporter()
         Private exporter.DataLoadingError += AddressOf Exporter_DataLoadingError
        '...
         Private Shared Sub Exporter_DataLoadingError(ByVal sender As Object, ByVal e As DataLoadingErrorEventArgs)
            For Each [error] As DataLoadingError In e.Errors
                Console.WriteLine($"The following error occurs in {error.DataSourceName}: {error.Error}")
            Next [error]
         End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DataLoadingError 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#L95

exporter.DashboardItemDataLoadingError += Exporter_DashboardItemDataLoadingError;
exporter.DataLoadingError += Exporter_DataLoadingError;
// Export Dashboard to PDf and attach to the Mail Message.

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

exporter.DashboardItemDataLoadingError += Exporter_DashboardItemDataLoadingError;
exporter.DataLoadingError += Exporter_DataLoadingError;

VB.NET

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

AddHandler exporter.DashboardItemDataLoadingError, AddressOf Exporter_DashboardItemDataLoadingError
AddHandler exporter.DataLoadingError, AddressOf Exporter_DataLoadingError
' Export Dashboard to PDf and attach to the Mail Message.

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

AddHandler exporter.DashboardItemDataLoadingError, AddressOf Exporter_DashboardItemDataLoadingError
AddHandler exporter.DataLoadingError, AddressOf Exporter_DataLoadingError
Dim message = New MimeMessage()