The requested page is not available for the requested platform. You are viewing the content for Default platform.

DashboardConfigurator.DataLoading Event

Allows you to provide data for the DashboardObjectDataSource.

Namespace: DevExpress.DashboardWeb

Assembly: DevExpress.Dashboard.v19.1.Web.dll

Declaration

public event DataLoadingWebEventHandler DataLoading
Public Event DataLoading As DataLoadingWebEventHandler

Event Data

The DataLoading event handler receives an argument of the DataLoadingWebEventArgs type. 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)
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)
Parameters Provides access to parameter values passed to the object data source.
(Inherited from DataLoadingEventArgs)

Remarks

Important

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.

Examples

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.


@{
    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);
}).GetHtml()
</div>
See Also