Activates a worksheet in a workbook from an established Excel session. Used to activate an existing worksheet inside a Microsoft Excel document that was previously created or opened using AWE's Create Workbook or Open Workbook actions. Other Excel actions such as Activate Cell or Get Active Cell can be used in subsequent steps.
Declaration
<AMEXCELACTIVATEWORKSHEET WORKSHEET="number" BYINDEX="YES/NO" />
See Also: Excel Actions Example, Create Workbook, Open Workbook, Close Workbook, Add Worksheet, Get Cell, Set Cell, Cells to Dataset, Dataset to Cells
|
AWE's Excel actions use Microsoft's Excel automation engine to perform their work. Therefore, Microsoft Excel must be licensed and installed on the system in order for these actions to work. Excel objects run in the context of the user executing them. If EFT is running as a Local System, then the Excel object is executed using the Local System profile. Before using an Excel action in Event Rules, refer to Globalscape Knowledgebase article #11089 for important information. This action is only useful in conjunction with other Excel actions. It is not possible to use AWE's Excel actions on a spreadsheet that was not opened by the Open Workbook action or created by the Create Workbook action. |
Property |
Type |
Required |
Default |
Markup |
Description |
Session Name |
Text |
Yes |
ExcelSess1 |
SESSION="ExcelSess7" |
The name of the session to associate with this Excel action. Numerous sessions can exist within a single task allowing several spreadsheets to be open simultaneously. If working with only one document, this can remain at the default name, which is Excelsess1. |
Activate worksheet by name |
Text |
Yes |
Sheet1 |
a)WORKSHEET="SheetName" b)WORKSHEET="3" |
If enabled, specifies the name of the worksheet that should be activated. By default this is the text caption on the worksheet, however if the By Index parameter is enabled, this value can be a number (starting at 1). |
Activate worksheet by index |
Yes/No |
No |
No |
BYINDEX="YES" |
If enabled, specifies that the WORKSHEET parameter is a number and not a text caption. An index number is a sequential number assigned to a sheet, based on the position of its sheet tab (counting from the left) among sheets of the same type. |