Difference between revisions of "Activity:CreateOLEExcelScope (Activity)"
(Created page with "The CreateOLEExcelScope opens an Excel file and provides access to its workbooks and sheets. {{Attention|Only Excel 97-2003 (*.xls) is supported yet!}} =Description= {{Activ...") |
|||
| (13 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
The CreateOLEExcelScope opens an Excel file and provides access to its workbooks and sheets. | The CreateOLEExcelScope opens an Excel file and provides access to its workbooks and sheets. | ||
| − | |||
| − | |||
=Description= | =Description= | ||
| Line 20: | Line 18: | ||
! Argument!! Type !! Direction !! Purpose | ! Argument!! Type !! Direction !! Purpose | ||
|- align="left" | |- align="left" | ||
| − | | | + | | ContainsHeader|| {{Boolean_MSDN}}|| In || Excel sheet has headers |
|- align="left" | |- align="left" | ||
| − | | | + | | DisplayName|| {{String_MSDN}}|| In || Diplay name of the activity |
|- align="left" | |- align="left" | ||
| − | | | + | | FullPath|| {{String_MSDN}}|| In || The full path of the file |
|- align="left" | |- align="left" | ||
| Password|| {{String_MSDN}}|| In || The corresponding password for the user | | Password|| {{String_MSDN}}|| In || The corresponding password for the user | ||
|- align="left" | |- align="left" | ||
| − | | | + | | Result|| {{Boolean_MSDN}}|| Out || True if successful, false if failed |
|- align="left" | |- align="left" | ||
| − | | | + | | Tables|| List<[[OLETableDescriptor]]>|| Out || not used |
|} | |} | ||
===Usage=== | ===Usage=== | ||
| − | This activity is used to | + | 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 [[Activity:CreateOLETableScope (Activity)|CreateOLETableScope]] activities, either as direct children but also wrapped within looping activities like ForEach or While. |
| + | |||
| + | {{Attention|On 32 bit platforms only .xls files can be processed, whereas on 64 bit platforms also new Excel extensions are possible.}} | ||
=Example= | =Example= | ||
| − | The | + | The CreateOLEExcelScope activity with a workflow and its arguments. |
| − | + | {{Hint|Check '''ContainsHeader''' if the Excel document uses a header row!}} | |
| − | [[File: | + | [[File:UI_Activity_CreateOLEExcelScope.png|border|CreateOLEExcelScope]] |
| − | + | [[File:UI_Activity_CreateOLEExcelScope_Arguments.png|border|CreateOLEExcelScope]] | |
<headertabs /> | <headertabs /> | ||
| Line 46: | Line 46: | ||
* [[Workflow Designer]] | * [[Workflow Designer]] | ||
* [[Activity:CreateOLETableScope (Activity)]] | * [[Activity:CreateOLETableScope (Activity)]] | ||
| − | |||
| − | [[Category:OLE]] | + | [[Category:OLE|CreateOLEExcelScope (Activity)]] |
Latest revision as of 14:41, 23 September 2015
The CreateOLEExcelScope opens an Excel file and provides access to its workbooks and sheets.
[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.
 | On 32 bit platforms only .xls files can be processed, whereas on 64 bit platforms also new Excel extensions are possible. |
Example
The CreateOLEExcelScope activity with a workflow and its arguments.
 | Check ContainsHeader if the Excel document uses a header row! |
