DashboardConfigurator.ExcelDataSourceBeforeFill Event

Provides the capability to change options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files.

Namespace: DevExpress.DashboardWeb

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

NuGet Package: DevExpress.Web.Dashboard.Common

Declaration

C#

public event ExcelDataSourceBeforeFillWebEventHandler ExcelDataSourceBeforeFill

VB.NET

Public Event ExcelDataSourceBeforeFill As ExcelDataSourceBeforeFillWebEventHandler

Event Data

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

Property	Description
DashboardId	Gets the identifier of the dashboard for which the event was raised.
DataSourceComponentName	Gets the component name of the Excel data source for which the event was raised. Inherited from DashboardExcelDataSourceBeforeFillEventArgs.
DataSourceConnectionName	Inherited from DashboardExcelDataSourceBeforeFillEventArgs.
DataSourceName	Inherited from DashboardExcelDataSourceBeforeFillEventArgs.
FileName	Gets or sets a path to the Microsoft Excel workbook or CSV file. Inherited from DashboardExcelDataSourceBeforeFillEventArgs.
SourceOptions	Gets or sets options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files. Inherited from DashboardExcelDataSourceBeforeFillEventArgs.
Stream	Inherited from DashboardExcelDataSourceBeforeFillEventArgs.
StreamDocumentFormat	Inherited from DashboardExcelDataSourceBeforeFillEventArgs.

Remarks

Tip

For information on how to use the DashboardConfigurator‘s API, see the following topic: Server-Side API Overview.

The ExcelDataSourceBeforeFill event is raised for dashboards supplied with data using DashboardExcelDataSource and provides the capability to change settings related to loading the Microsoft Excel workbook (XLS, XLSX or XLSM files) or CSV file. For instance, you can specify a new file path (DashboardExcelDataSourceBeforeFillEventArgs.FileName) or change options used to extract data (DashboardExcelDataSourceBeforeFillEventArgs.SourceOptions).

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ExcelDataSourceBeforeFill 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#

mvc-dashboard-obtain-data-from-online-spreadsheets/CS/MvcDashboard/App_Start/DashboardConfig.cs#L46

DashboardConfigurator.Default.SetDataSourceStorage(DataSourceStorage);
DashboardConfigurator.Default.ExcelDataSourceBeforeFill += DefaultOnExcelDataSourceBeforeFill;
DashboardConfigurator.Default.ConfigureDataReloadingTimeout += (s, e) => {