Jump to: navigation, search

Difference between revisions of "Activity:CreateOLEExcelScope (Activity)"


(Example)
 
(5 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.
{{Attention|Only files from Excel 97-2003 (*.xls) is supported yet!}}
 
  
 
=Description=
 
=Description=
Line 29: Line 28:
 
| Result|| {{Boolean_MSDN}}|| Out || True if successful, false if failed
 
| Result|| {{Boolean_MSDN}}|| Out || True if successful, false if failed
 
|- align="left"
 
|- align="left"
| Tables|| List<{{OLETableDescriptor}}>|| Out || not used
+
| Tables|| List<[[OLETableDescriptor]]>|| Out || not used
 
|}
 
|}
  
 
===Usage===
 
===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 [[Activity:CreateOLETableScope (Activity)|CreateOLETableScope]] activities, either as direct children but also wrapped within looping activities like ForEach or While.
 
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 CreateOLEExcelScope activity with a workflow and its arguments.
 
The CreateOLEExcelScope activity with a workflow and its arguments.
[[File:UI_Activity_CreateOLEExcelScope.png|CreateOLEExcelScope]]
+
{{Hint|Check '''ContainsHeader''' if the Excel document uses a header row!}}
[[File:UI_Activity_CreateOLEExcelScope_Arguments.png|CreateOLEExcelScope]]
+
[[File:UI_Activity_CreateOLEExcelScope.png|border|CreateOLEExcelScope]]
 +
[[File:UI_Activity_CreateOLEExcelScope_Arguments.png|border|CreateOLEExcelScope]]
 
<headertabs />
 
<headertabs />
  
Line 45: Line 47:
 
* [[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.

IC Attention.pngOn 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.

IC Hint square.pngCheck ContainsHeader if the Excel document uses a header row!

CreateOLEExcelScope CreateOLEExcelScope

See also