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.v18.2.Web.dll

Declaration

public event ExcelDataSourceBeforeFillWebEventHandler ExcelDataSourceBeforeFill
Public Event ExcelDataSourceBeforeFill As ExcelDataSourceBeforeFillWebEventHandler

The ExcelDataSourceBeforeFill event handler receives an argument of the ExcelDataSourceBeforeFillWebEventArgs type. 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.
DataSourceName Gets the name of the Excel data source for which the event was raised.
FileName Gets or sets a path to the Microsoft Excel workbook or CSV file.
SourceOptions Gets or sets options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files.
Stream Gets or sets a stream that contains a Microsoft Excel workbook or CSV file.
StreamDocumentFormat Gets or sets the format of the document contained in the ExcelDataSourceBeforeFillWebEventArgs.Stream.
Important

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

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 (ExcelDataSourceBeforeFillWebEventArgs.FileName) or change options used to extract data (ExcelDataSourceBeforeFillWebEventArgs.SourceOptions).

See Also