Add Worksheet Action

Description

Adds a new Excel worksheet to a workbook in an established Excel session (a Microsoft Excel document that was previously created or opened using Automated Workflow's Excel actions.) This action is only useful in conjunction with the 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

<AMEXCELADDWORKSHEET SESSIONNAME="text" WORKSHEETNAME="text" LASTWORKSHEET="yes/no" TEMPLATENAME="text">

Example

<AMEXCELCREATEWORKBOOK WORKBOOK="c:\myexceldocument.xls">

     <AMEXCELADDWORKSHEET WORKSHEETNAME="My New Sheet" LASTWORKSHEET="YES">

     <AMEXCELSETCELL NEWVALUE="Set this data here" CELLROW="1" CELLCOLUMN="1">

     <AMEXCELSETCELL NEWVALUE="and this here" CELLROW="2" CELLCOLUMN="1">

<AMEXCELCLOSEWORKBOOK>

General Tab Parameters

Session name: Specifies the session name to identify which document should be changed from prior Excel steps. 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 "Default"
MARKUP: SESSION="YES"

Worksheet name: Specifies the name of the new worksheet that will be created. The file will not be actually changed on the hard disk until the file is saved either manually or using the Close Workbook action.

Text, Required
MARKUP: WORKSHEETNAME="c:\file.xls"

Insert worksheet before active one or Add worksheet at the end: When enabled, specifies that when working with the workbook, the Microsoft Excel Window will not be displayed (processing will occur in the background). Usually this option should be left unchecked when building/debugging, but enabled for production.

Yes/No, Optional - Default NO
MARKUP:
a) LASTWORKSHEET="yes"

Sheet type: Specifies what type of worksheet should be added. The available options are:

  • worksheet: Specifies that a new worksheet should be added to the workbook document

  • chart: Specifies that a new chart should be added to the workbook document

  • macro: Specifies that a new macro should be added to the workbook document

  • dialog: Specifies that a new dialog should be added to the workbook document

  • specific template: Specifies that a new template should be used when adding a worksheet to the workbook document

Options, Optional Default worksheet
MARKUP: SHEETTYPE="chart"

Use template: Specifies the file name of a template that should be used when adding the worksheet. Excel Templates have the file extension .xlt. Only available when specific template is selected in Sheet type.

Text, Optional Default= ""
MARKUP: TEMPLATE="c:\mytemplate.xlt"

See Also

Create Workbook, Open Workbook, Close Workbook,  Activate Worksheet, Get Cell, Set Cell, Cells to Dataset, Dataset to Cells