DashboardControl.AsyncExcelDataSourceBeforeFill Event

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

Namespace: DevExpress.DashboardWpf

Assembly: DevExpress.Dashboard.v18.2.Wpf.dll

Declaration

public event ExcelDataSourceBeforeFillEventHandler AsyncExcelDataSourceBeforeFill
Public Event AsyncExcelDataSourceBeforeFill As ExcelDataSourceBeforeFillEventHandler

The AsyncExcelDataSourceBeforeFill event handler receives an argument of the ExcelDataSourceBeforeFillEventArgs type. The following properties provide information specific to this event.

Property Description
DataSourceComponentName Gets the component name of the Excel data source for which the event was raised.
DataSourceName Sets 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 ExcelDataSourceBeforeFillWpfEventArgs.Stream.

The AsyncExcelDataSourceBeforeFill 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 a CSV file. For instance, you can specify a new file path (ExcelDataSourceBeforeFillEventArgs.FileName) or change options used to extract data (ExcelDataSourceBeforeFillEventArgs.SourceOptions).

See Also