Skip to main content

DashboardConfigurator.DataLoading Event

Allows you to provide data for the DashboardObjectDataSource.

Namespace: DevExpress.DashboardWeb

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


public event DataLoadingWebEventHandler DataLoading

Event Data

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

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



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

The DataLoading event is raised when the dashboard needs to load data from a data source assigned using the DashboardObjectDataSource. Use the event parameter’s DataLoadingEventArgs.Data property to provide data for this data source. This object should implement the IEnumerable or IListSource interface.

For other data source types (for instance, DashboardSqlDataSource or DashboardOlapDataSource), you can handle the DashboardConfigurator.ConfigureDataConnection event to customize connection parameters.


This example shows how to bind the ASP.NET MVC Dashboard extension to the Object Data Source and supply it with data using the DashboardConfigurator.DataLoading event. To use the created data source, run the application and create a new dashboard.

View Example

    ViewBag.Title = "Index";

<div style="position: absolute; left: 0; right: 0; top:0; bottom:0;">
    @Html.DevExpress().Dashboard(settings => {
    settings.Name = "Dashboard";
    settings.Width = Unit.Percentage(100);
    settings.Height = Unit.Percentage(100);

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


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.

See Also