 | ExcelDataConnector Class |
Provides access to data in an Excel file.
Inheritance HierarchySystemObject
Ranorex.Core.DataDataConnector
Ranorex.Core.DataFileDataConnector
Ranorex.Core.DataExcelDataConnector
Ranorex.Core.DataDataConnector
Ranorex.Core.DataFileDataConnector
Ranorex.Core.DataExcelDataConnector
Namespace: Ranorex.Core.Data
Assembly: Ranorex.Plugin.Office (in Ranorex.Plugin.Office.dll) Version: 12.7.4-git.38314c06
SyntaxThe ExcelDataConnector type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ExcelDataConnector(XmlNode) |
Initializes a new instance of the ExcelDataConnector class.
|
| ExcelDataConnector(String, String, String, String, CheckState) |
Initializes a new instance of the ExcelDataConnector class.
|
Properties| Name | Description | |
|---|---|---|
 | FileName |
Gets or sets the name of the file.
(Inherited from FileDataConnector.) |
| Id |
Gets or sets the unique ID of the source.
(Inherited from DataConnector.) |
| IncludeFile |
Gets or sets a value specifying whether the file should be included
into the associated project.
(Overrides FileDataConnectorIncludeFile.) |
| IsReadOnly |
Gets or sets a value indicating whether this instance is read-only.
(Inherited from DataConnector.) |
| Name |
Gets or sets the name of the source.
(Inherited from DataConnector.) |
| ResolvedFileName |
Gets the name of the resolved file that takes relative paths into account.
(Inherited from FileDataConnector.) |
| WorksheetName |
Gets or sets the name of the worksheet.
|
| WorksheetRange |
Gets or sets the worksheet range.
|
| XmlIdentifier |
Gets the unique identifier for serialization and deserialization purposes as well as factory creation.
(Overrides DataConnectorXmlIdentifier.) |
Methods| Name | Description | |
|---|---|---|
 | CloseWorkBook |
Closes the workbook wrapped by the IWorkbookContext
|
| Dispose |
Clean up any resources being used.
(Inherited from DataConnector.) |
 | Dispose(Boolean) |
Clean up any resources being used.
(Inherited from DataConnector.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetActiveWorkSheetName |
Gets an active work sheet name of the specified workbookFilename.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetWorkbookContext |
This method is used internally to get a disposable workbook context. It is not intended for to be used in your code.
|
| GetWorkSheetNames |
Gets a list containing the work sheet names of the specified workbookFilename.
|
| GetWorkSheetRangeNames |
Gets a list of valid ranges from the specified the work sheet.
|
| GetXMLNode |
Gets an XML node containing the definition of this source.
(Inherited from DataConnector.) |
| GetXMLNodeDerived(XmlNode) |
Add DataSource specific information from derived classes to the node
(Inherited from DataConnector.) |
| GetXMLNodeDerived(XmlNode) |
Add DataSource specific information from derived classes to the node
|
| IsExcelInstalled |
Determines whether Microsoft Excel is installed on this machine.
|
| IsRangeValid |
Determines whether the specified range is a valid range
in the specified workSheetName in the work book workbookFilename.
|
| IsWorkBookValid |
Determines whether the specified workbookFilename is a valid work book.
|
| IsWorkSheetValid |
Determines whether the specified workSheetName is a valid work sheet
in the specified workbookFilename.
|
| LoadColumns |
Loads the data columns from the source.
(Inherited from DataConnector.) |
| LoadColumnsImpl(ColumnCollection) |
Loads the data columns from the source.
(Overrides DataConnectorLoadColumnsImpl(ColumnCollection).) |
| LoadColumnsImpl(ColumnCollection, Int32) |
Loads the data columns and number of rows from the source.
(Overrides DataConnectorLoadColumnsImpl(ColumnCollection, Int32).) |
| LoadData |
Loads the data from the source.
(Inherited from DataConnector.) |
| LoadDataImpl |
Loads the data from the source.
(Overrides FileDataConnectorLoadDataImpl(ColumnCollection, RowCollection).) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnFileNameChanged |
Called when the filename changes
(Inherited from FileDataConnector.) |
| StoreData |
Stores the data to the data source.
(Inherited from DataConnector.) |
| StoreDataImpl |
Stores the data to the data source. Currently not supported.
(Overrides DataConnectorStoreDataImpl(ColumnCollection, RowCollection).) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
 | AutoRangeLocalizedString |
Translation of AutoRange property for UI Localization
|
| FactorySerializationKey |
The unique key for serialization and factory creation (see XmlIdentifier).
|
RemarksMicrosoft Excel needs to be installed in order to use this source.
See Also