Get Active Worksheet Action

Description

Retrieves the name or index of the currently active worksheet in an established Excel session (a Microsoft Excel document that was previously created or opened using one of Automated Workflow's Excel actions). The action populates either or both of two variables, one for the worksheet name and the other for the index. This action is only useful in conjunction with other Excel actions found in Automated Workflow.

IMPORTANT: The Excel actions in Automated Workflow use the Microsoft Excel automation engine to perform their work. Because of this Microsoft Excel must be licensed and installed on the system to use the Excel Actions.

Declaration

<AMEXCELGETACTIVEWORKSHEET SESSION="Text" WORKSHEETNAMEVARIABLE="Text" WORKSHEETINDEXVARIABLE="Text" />

Example

<AMEXCELGETACTIVEWORKSHEET SESSION="ExcelSess1" WORKSHEETNAMEVARIABLE="VariableName1" WORKSHEETINDEXVARIABLE="VariableName2" />

General Tab Parameters

Session name: Specifies the session name to identify which document should be acted on. This allows several Excel files to be open simultaneously. If working with only one document, this value should not be changed from its default value.

Text, Optional - Default "ExcelSess1"
MARKUP: SESSION="ExcelSess2"

Populate variable with worksheet name: Specifies the variable to populate with the worksheet name.

Text, Optional
MARKUP: WORKSHEETNAMEVARIABLE="VariableName1"

Populate variable with worksheet index: Specifies the variable to populate with the index number for the worksheet.

Text, Optional
MARKUP: WORKSHEETINDEXVARIABLE="VariableName2"