XenoGuard 4.0 Documentation

Rename Sheet

ActionStep Reference » Windows » File Handling » Excel » Rename Sheet

The ActionStep Excel Rename Sheet assigns a new name to a specific worksheet of an Excel file.


[-] Hide
  1. Open the Windows node in the Workspace Explorer.
  2. Open the File Handling node.
  3. In the Excel node, select the Rename Sheet ActionStep.

Parameters:

The ActionStep has the following input parameters:


NAME DESCRIPTION
Path Name
Specifies the path of the Excel File where the worksheet is to be renamed.

Allowed Context Scopes
 [Fixed, Local, Global]
Allowed Context Types
 [Variable, Parameter, Enum] 
Current Sheet Name
The current name of the worksheet that is to be replaced.

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]
New Sheet Name
The new name of the worksheet that replaces the current sheet name. 

Allowed Context Scopes
 [Fixed, Local, Global]
Allowed Context Types
 [Variable, Parameter, Enum] 

Results:

The ActionStep returns the following results:


NAME
DESCRIPTION
Result
Confirms if the worksheet was successfully added or not.

Allowed Context Scope [Fixed]
Allowed Data Type [Boolean]
Path Name
The complete path of the Excel file where the worksheet was added.

Allowed Context Scope [Fixed]

Example 1 (Modify the name of a worksheet):

This example changes the name of a specified worksheet of an Excel file. The Current Sheet Name and the Row Count are concatenated and assigned as the name of the worksheet. When the ActionStep is successful, a notice that the worksheet was renamed is then output via the Message Box.


See other Excel operations:

Create File
Get Sheet Information
Add Sheet
Delete Sheet
Insert Data
Update Data
Get Data
Format Cells
Clear Cells
Delete Cells