DashboardViewer.AsyncDataLoading Event

Allows you to provide data for the DashboardObjectDataSource in asynchronous mode.

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v23.2.Win.dll

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

public event DataLoadingEventHandler AsyncDataLoading

VB.NET

Public Event AsyncDataLoading As DataLoadingEventHandler

Event Data

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

Property	Description
Data	Gets or sets data for the current data source.
DataId	Gets an object data source’s unique identifier.
DataSourceComponentName	Get the component name of the data source for which the event has been raised.
DataSourceName	Gets the name of the data source for which the event has been raised.
OverwriteDataSourceProperty	Specifies whether the DataSource and DataMember properties of the DashboardObjectDataSource are set when data is supplied in the event handler.
Parameters	Provides access to parameter values passed to the object data source.

Remarks

The AsyncDataLoading event is raised in asynchronous mode when the dashboard loads data from the DashboardObjectDataSource. Use the event parameter’s e.Data property to provide data for this data source. The data object should implement the IEnumerable or IListSource interface.

Note

You cannot access a control’s properties such as the DashboardControl.Dashboard property through the AsyncDataLoading event because it receives data asynchronously from a background thread.

Related GitHub Examples

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

winviewer-how-to-create-custom-card-layout-template/CS/ViewerForm.cs#L21

DashboardObjectDataSource dataSource = new DashboardObjectDataSource();
dashboardViewer1.AsyncDataLoading += (s, ev) => {
    ev.Data = DataGenerator.GenerateTestData();

winforms-dashboard-apply-conditional-formatting-to-grid-cells/CS/Dashboard_ConditionalFormatting_Grid/DateOccurringForm.cs#L8

InitializeComponent();
dashboardViewer1.AsyncDataLoading += OnDashboardViewerAsyncDataLoading;
dashboardViewer1.DataSourceOptions.ObjectDataSourceLoadingBehavior = DevExpress.DataAccess.DocumentLoadingBehavior.LoadAsIs;

VB.NET

winviewer-how-to-create-custom-card-layout-template/VB/ViewerForm.vb#L17

Dim dataSource As New DashboardObjectDataSource()
AddHandler dashboardViewer1.AsyncDataLoading, Sub(s, ev)
                                                  ev.Data = DataGenerator.GenerateTestData()

winforms-dashboard-apply-conditional-formatting-to-grid-cells/VB/Dashboard_ConditionalFormatting_Grid/DateOccurringForm.vb#L11

InitializeComponent()
AddHandler dashboardViewer1.AsyncDataLoading, AddressOf OnDashboardViewerAsyncDataLoading
dashboardViewer1.DataSourceOptions.ObjectDataSourceLoadingBehavior = DevExpress.DataAccess.DocumentLoadingBehavior.LoadAsIs

Implements

AsyncDataLoading