Back to Devexpress

ExcelDataSource Members

corelibraries-devexpress-dot-dataaccess-dot-excel-dot-exceldatasource-dot-underscore-members.md

latest10.5 KB
Original Source

ExcelDataSource Members

The data source that extracts data from Microsoft Excel workbooks or CSV files.

Constructors

NameDescription
ExcelDataSource()Initializes a new instance of the ExcelDataSource class.

Properties

NameDescription
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
ContainerGets the IContainer that contains the Component. Inherited from Component.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
FileNameGets or sets a path to the Microsoft Excel workbook or CSV file.
NameInherited from DataComponentBase.
SchemaGets the ExcelDataSource schema.
SiteGets or sets the ISite of the Component. Inherited from Component.
SourceOptionsGets or sets options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files.
StreamGets or sets a stream that contains a Microsoft Excel workbook or CSV file.
StreamDocumentFormatGets or sets the format of the document contained in the ExcelDataSource.Stream.

Methods

NameDescription
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) protectedReleases the unmanaged resources used by the Component and optionally releases the managed resources. Inherited from Component.
Equals(Object, Object) staticDetermines 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.
Fill(IEnumerable<IParameter>)Retrieves the data from the Excel data source with the specified parameters.
FillAsync()Populates the ExcelDataSource in an asynchronous manner.
FillAsync(CancellationToken)Populates the ExcelDataSource in an asynchronous manner and uses the cancellationToken parameter to send the cancellation signal.
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() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates 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.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
SaveToXml()Saves the XML definition of the 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

NameDescription
BeforeFillProvides the capability to change options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files.
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.

See Also

ExcelDataSource Class

DevExpress.DataAccess.Excel Namespace