Skip to main content

DashboardExcelDataSource Members

A data source used to extract data from Microsoft Excel workbooks or CSV files.

Constructors

Name Description
DashboardExcelDataSource() Initializes a new instance of the DashboardExcelDataSource class.
DashboardExcelDataSource(String) Initializes a new instance of the DashboardExcelDataSource class.

Properties

Name Description
CalculatedFields Provides access to a data source’s calculated fields.
CanRaiseEvents protected Gets a value indicating whether the component can raise an event. Inherited from Component.
ComponentName Gets or sets the component name of the data source.
ConnectionName Specifies the name of the created connection to an Excel data source.
Container Gets the IContainer that contains the Component. Inherited from Component.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
FileName Gets or sets a path to the Microsoft Excel workbook or CSV file. Inherited from ExcelDataSource.
Filter Gets or sets the logical expression to be applied to the data for filtering.
LockUIOnDataLoading static Gets or sets whether the user interface is locked when the data source loads data.
Name Gets or sets the data source name.
Schema Gets the ExcelDataSource schema. Inherited from ExcelDataSource.
Site Gets or sets the ISite of the Component. Inherited from Component.
SourceOptions Gets or sets options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files. Inherited from ExcelDataSource.
Stream Gets or sets a stream that contains a Microsoft Excel workbook or CSV file. Inherited from ExcelDataSource.
StreamDocumentFormat Gets or sets the format of the document contained in the ExcelDataSource.Stream. Inherited from ExcelDataSource.

Methods

Name Description
BeginInit() For internal use.
CreateObjRef(Type) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
Dispose() Releases all resources used by the Component. Inherited from Component.
Dispose(Boolean) protected Releases the unmanaged resources used by the Component and optionally releases the managed resources. Inherited from Component.
EndInit() For internal use.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Fill() Retrieves the data from the Excel data source. Inherited from ExcelDataSource.
Fill(IEnumerable<IParameter>) Retrieves the data from the connected data source with the specified parameters.
FillAsync() Populates the ExcelDataSource in an asynchronous manner. Inherited from ExcelDataSource.
FillAsync(CancellationToken) Populates the ExcelDataSource in an asynchronous manner and uses the cancellationToken parameter to send the cancellation signal. Inherited from ExcelDataSource.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetLifetimeService() Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetService(Type) Inherited from DataComponentBase.
GetType() Gets the Type of the current instance. Inherited from Object.
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
LoadFromXml(XElement) Loads the data source schema definition from XML.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protected Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
RebuildResultSchema() Updates the result schema of a data source available on the client according to the current data source structure. Inherited from ExcelDataSource.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
SaveToXml() Saves the XML definition of the object data source schema.
ToString() Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.

Events

Name Description
BeforeFill Provides the capability to change options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files. Inherited from ExcelDataSource.
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
See Also