CreateOLEExcelScope (Activity)
The CreateOLEExcelScope opens an Excel file and provides access to its workbooks and sheets.
 | Only files from Excel 97-2003 (*.xls) is supported yet! |
[edit]
Description
| Create OLE Excel Scope | |
|---|---|
| Name | CreateOLEExcelScope |
| Purpose | Open an Excel file via OLE |
| Category | UBIK Data Exchange |
| Returns | True if successful |
| Version | 2.4.1+ |
Arguments
| Argument | Type | Direction | Purpose |
|---|---|---|---|
| ContainsHeader | Boolean | In | Excel sheet has headers |
| DisplayName | String | In | Diplay name of the activity |
| FullPath | String | In | The full path of the file |
| Password | String | In | The corresponding password for the user |
| Result | Boolean | Out | True if successful, false if failed |
| Tables | List<OLETableDescriptor> | Out | not used |
Usage
This activity is used to open an Excel document as an OLE compliant data source. It is a nestable activity, which means it can host any amount of sub-activities that will be processed sequentially. The hosted activities are typically CreateOLETableScope activities, either as direct children but also wrapped within looping activities like ForEach or While.
Example
The CreateOLEExcelScope activity, as used in the larger example "Read data from an Excel document":
