The Automation Toolkit let users automate common tasks in Excel. It uses Low Code / No Code framework so users can build complete automation processes just by entering values and formulas in cells.
Use this reference documentation to learn more about each action available inside the Automation Toolkit.
Contents
Click the links below to jump to the reference documentation information about each action.
Actions Reference
The actions below are organized in alphabetical order.
Automation If False GoTo
Purpose:
- Where the value of the named cell is FALSE, the automation jumps to the named Automation Reference point
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Sheet Name: Name of a sheet in the workbook (e.g. Sheet1)
- Cell: Cell reference of the value to be assessed as FALSE
- GoTo Reference: The named Automation Reference point to jump to if the named cell is FALSE (e.g. myReference)
Notes:
- To be used in conjunction with the Automation Reference action
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- Error Number EOTG001: GoTo References does not exist.
- The named cell reference is invalid
Automation If True GoTo
Purpose:
- Where the value of the named cell is TRUE, the automation jumps to the named Automation Reference point
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Sheet Name: Name of a sheet in the workbook (e.g. Sheet1)
- Cell: Cell reference of the value to be assessed as TRUE
- GoTo Reference: The named Automation Reference point to jump to if the named cell is TRUE (e.g. myReference)
Notes:
- To be used in conjunction with the Automation Reference action
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- Error Number EOTG001: GoTo References does not exist.
- The named cell reference is invalid
Automation Reference
Purpose:
- Creates a reference point to jump to
Parameters:
- Reference: A text string to be used as a reference point (e.g. myReference)
Notes:
- To be used in conjunction with Automation If True GoTo or Automation If False GoTo
Common Errors:
- (None)
Automation Run
Purpose:
- Runs another automation recipe
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Sheet Name: Name of a sheet in the workbook containing the automation recipe (e.g. Sheet1)
Notes:
- (None)
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- Error Number 28: Out of Stack space
- The named worksheet does not contain an automation recipe
- Error Number 1004: Method ‘Range’ of object ‘_Worksheet’ failed
- The named worksheet does not contain an automation recipe
Automation Settings Change
Purpose:
- Changes the automation recipe parameter separator (default is a line break)
- Turn the automation Run Time message on/off
Parameters:
- Settings List: Can be the words Parameter Separator or Show Run Time. Change all settings at the same time by including both with a separator between.
- Value List: The corresponding values to use for Parameter Separator (e.g. text string) or Show Run Time (e.g. True or False).
- Separator: The character used to separate the Settings List and Value Lists parameters above
Notes:
- The Show Run Time parameter accepts True or 1 as valid True values, all other values are treated as False
Common Errors:
- Error Number 450: Wrong number of arguments or invalid property assignment
- The new separator string contains the existing separator string.
Automation Stop
Purpose:
- Stops the automation running
Parameters:
- (None)
Notes:
- (None)
Common Errors:
- (None)
Automation Wait
Purpose:
- Pauses the automation for the specified time period
Parameters:
- Time: The time to wait in hours, minutes and seconds (hh:mm:ss)
Notes:
- Excel remains locked for the waiting time period
- The wait completes at systems clock’s next whole second (i.e. 00:00:05 will be between 4 and 5 seconds)
Common Errors:
- Error Number 13: Type mismatch
- The Time parameter is not in a valid hh:mm:ss format
Environment Info (Get)
Purpose:
- Returns information about the users environment using the VBA Environ function.
Parameters:
- Info: Name of a parameter held within the environ function
- Return File Name: Name of an open Excel workbook to return the value to (e.g. File Name.xlsx)
- Return Sheet Name: Name of a sheet in workbook to return the value to (e.g. Sheet1)
- Return Cell: Name of a cell reference on the worksheet to return the value to (e.g. A1)
Notes:
- Valid Info values include: ALLUSERSPROFILE, APPDATA, CommonProgramFiles, CommonProgramFiles(x86), CommonProgramW6432, COMPUTERNAME, ComSpec, DriverData, FPS_BROWSER_APP_PROFILE_STRING, FPS_BROWSER_USER_PROFILE_STRING, HOMEDRIVE, HOMEPATH, LOCALAPPDATA, LOGONSERVER, NUMBER_OF_PROCESSORS, OneDrive, OneDriveCommercial, OS, Path, PATHEXT, PROCESSOR_ARCHITECTURE, PROCESSOR_IDENTIFIER, PROCESSOR_LEVEL, PROCESSOR_REVISION, ProgramData, ProgramFiles, ProgramFiles(x86), ProgramW6432, PSModulePath, PUBLIC, SESSIONNAME, SystemDrive, SystemRoot, TEMP, TMP, USERDOMAIN, USERDOMAIN_ROAMINGPROFILE, USERNAME, USERPROFILE, windir
- Where invalid parameter names used an empty string is returned
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- The cell name is not valid
Excel Calc Mode Change
Purpose:
- Changes the calculation mode for the Excel application
Parameters:
- Mode: Can be set to Automatic, Manual, Semiautomatic
Notes:
- Same settings as found in the ribbon Formulas > Calculation Options
- Semiautomatic is equivalent to Automatic except for data dables
- Invalid options revert to Automatic
Common Errors:
- (None)
Excel Calculate
Purpose: Recalculates all open workbooks.
Parameters:
- (None)
Notes:
- Same option as found the ribbon Formulas > Calculate (F9)
Common Errors:
- (None)
Excel Cell (Active) Get
Purpose: Returns the address, value or formula of the active cell
Parameters:
- Element: Defines the information to return valid elements are Address, Formula, or Value
- Return File Name: Name of an open Excel workbook to return the value to (e.g. File Name.xlsx)
- Return Sheet Name: Name of a sheet in workbook to return the value to (e.g. Sheet1)
- Return Cell: Name of a cell reference on the worksheet to return the value to (e.g. A1)
Notes:
- Where the Element string is invalid reverts to Value
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- The cell name is not valid
Excel Cell Formula Change
Purpose: Changes the formula inside a named cell
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Sheet Name: Name of a sheet in workbook (e.g. Sheet1)
- Cell: The cell references or named ranges contained on the sheet (e.g. A1)
- Formula: The formulas as a text string (e.g. =SUM(A2:D10))
Notes:
- (None)
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- The cell name is not valid
- Error 1004: Application-defined or object-defined error
- The formula string is not valid formula syntax
Excel Cell Get
Purpose: Returns the value or formula of a named cell.
Parameters:
- Element: Defines the information to return valid elements are Formula or Value
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Sheet Name: Name of a sheet in workbook (e.g. Sheet1)
- Cell: The cell references or named ranges contained on the sheet (e.g. A1)
- Return File Name: Name of an open Excel workbook to return the value to (e.g. File Name.xlsx)
- Return Sheet Name: Name of a sheet in workbook to return the value to (e.g. Sheet1)
- Return Cell: Name of a cell reference on the worksheet to return the value to (e.g. A1)
Notes:
- Where the Element string is invalid reverts to Value
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- The cell name is not valid
Excel Cell (Surrounding Region) Get
Purpose: Returns the address of a the surrounding region of a named cell
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Sheet Name: Name of a sheet in workbook (e.g. Sheet1)
- Cell: The cell references or named ranges contained on the sheet (e.g. A1)
- Return File Name: Name of an open Excel workbook to return the value to (e.g. File Name.xlsx)
- Return Sheet Name: Name of a sheet in workbook to return the value to (e.g. Sheet1)
- Return Cell: Name of a cell reference on the worksheet to return the value to (e.g. A1)
Notes:
- Where there is no surrounding region, the cell address is returned
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- The cell name is not valid
Excel Cell Value Change
Purpose: Changes the value inside named cells
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Sheet Name: Name of a sheet in workbook (e.g. Sheet1)
- Cells: List of cell references or named ranges contained on the sheet (e.g. A1,A10,B4)
- Values: List of values to change the corresponding cell references to (e.g. 10,40,500)
- Separator: The character used to separate the Cells and Values lists (e.g. a comma ( , ))
Notes:
- Cell changes can only be made one worksheet at a time.
- Range ( : ), Union ( , ) and Intersection ( ) operators can be used to define ranges, but only a single corresponding value is applied to each.
- If Colons, Commas or Spaces are used as separators the separator takes precedence over the standard operator activity
- The separator must not be contained in the Values list
- Where the number of cells listed exceed the number of values listed an error occurs
- Where the number of values listed exceed the number of cells, the un-matched values are ignored
- Can change cell values, cannot change formulas
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- The cell name is not valid
Excel Data Refresh
Purpose: Refreshes data in PivotTables, Tables and Queries,
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Type: Defines the dataobject type to refresh All, PivotTable, Query or Table
- Sheet Name: Name of a sheet in workbook (e.g. Sheet1). Not required for All or Query.
- Object Name: The name of the item to be refreshed (e.g. PivotTable1). Not required for All.
Notes:
- Where parameters are not required, the parameter name is still required, but with no value after the colon (:)
- For a Query Refresh the full VBA query name is required (e.g. Query – [Query Name])
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- The named query is not in the workbook
- Error 1004: Method ‘PivotTables’ of Object ‘_Worksheet’ failed
- The named PivotTable is not on the named worksheet
- Error 1004: Application-defined or object-defined error
- The named Table is not a Query Table
Excel Macro Run
Purpose: Runs a macro in a named workbook
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Macro Name: The name of the macro in the named workbook
- Arguments: The list of arguments to pass to the macro, with a separator character between each argument
- Separator: The character used to separate the arguments (e.g. a comma ( , ))
Notes:
- The arguments passed to the macro are all strings. They must be translated into the correct data type inside the macro.
Common Errors:
- Error Number 1004: Sorry, we couldn’t find [xxxxxx]. Is it possible it was moved, renamed or deleted?
- The File Name parameter is not an open workbook, or a valid reference to a close workbook.
- Error Number 1004: Cannot run the macro [xxxxxxx]. The Macro may not be available in this workbook or all macros may be disabled.
- The Macro was not found, or could not be executed due to being disabled.
- Error Number 449: Argument not optional
- The list of arguments provided contains fewer items than the arguments required for the macro.
- Error Number 450: Wrong number of arguments or invalid property assignment
- The list of arguments provided contains more items than the arguments required for the macro.
Excel Page Header Footer Change
Purpose: Changes the Header or Footer section of a specific sheet
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Sheet Name: Name of a sheet in workbook (e.g. Sheet1)
- Section: Name of the section to change. Valid section names are:
- Left Header
- Center Header
- Right Header
- Left Footer
- Center Footer
- Right Footer
- Value: A text string or section code. Valid section codes area
- &[Page] = Page number
- &[Pages] = Total number of pages
- &[Date] = Date
- &[Time] = Time
- &[Path] = File path
- &[File] = File name
- &[Tab] = worksheet name
Notes:
- The value parameter can be a mixture of text and section codes
- Section names without spaces between words are also permitted
- Invalid sections names are treated as Center Header by default
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
Excel PDF Save
Purpose: Saves the PrintArea of Excel sheets as PDFs.
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Sheets List: List of sheet names to include in the PDF file, split by a separator (e.g. Sheet1,Sheet2)
- Separator: The character used to separate the sheet names (e.g. a comma ( , ))
- PDF File Path: The full file path to save the PDF (e.g. C:\Folder Path\File Name.pdf)
Notes:
- Where no Sheets List is provided the entire Workbook is saved as a PDF
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheets in the Sheet List are not all in the workbook
- One or more named sheets do not have a PrintAreas set
- Error 1004: Application-defined or object-defined error
- The file path for the PDF is invalid
Excel Pivot Filter Change
Purpose: Changes the selected items in a Pivot Filter
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Sheet Name: Name of a sheet in workbook (e.g. Sheet1)
- Pivot Name: Name of the PivotTable on the worksheet (e.g. PivotTable1)
- Pivot Field: Name of field in the PivotTable (e.g. Field Name)
- Select List: List of values to select in the Pivot Field (e.g. Value1,Value2)
- Separator: The character used to separate the Select List (e.g. a comma ( , ))
Notes:
- If there are no items matching the Select List an error occurs (Error 1004: Unable to set the Visible property of the PivotItem class). Only the last item in the PivotTable remains visible.
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- Error 1004: Method ‘PivotTables’ of Object ‘_Worksheet’ failed
- The named PivotTable does not exist
- Error 1004: Unable to get the Pivot Fields property of the PivotTable class
- The named Pivot Field does not exist in the PivotTable
- Error 1004: Unable to set the Visible property of the PivotItem class
- The Select List has resulted in no visible items. The last item in the PivotTable remains.
Excel Power Query Settings Change
Purpose: Change Power Query settings for Background Refresh and Ignore Privacy
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Settings List: Can be the words Background Refresh to Ignore Privacy. Change all settings at the same time by including both with a separator between
- Values List: The corresponding values to use for Background Refresh (e.g. True or False) or Ignore Privacy (e.g. True or False).
- Separator: The character used to separate the Settings List and Values List(e.g. a comma ( , ))
Notes:
- Background refresh setting is applied to every query in the workbook
- Ignore Privacy is applied to the workbook
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- Error Number 13: Type mismatch
- The text strings provided in the Values list are not True or False values
Excel Range Copy & Paste
Purpose: Copies and pastes a range of cells, including all paste special options.
Parameters:
- Copy File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Copy Sheet Name: Name of a sheet in workbook (e.g. Sheet1)
- Copy Range: Reference to a cell range on a worksheet (e.g. A1:D10)
- Paste File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Paste Sheet Name: Name of a sheet in workbook (e.g. Sheet1)
- Paste Range: Reference to a cell range on a worksheet (e.g. A1:D10)
- Paste Type: The paste type to perform. Valid entries include:
- All
- All Except Borders
- All Merging Conditional Formats
- All Using Source Theme
- Column Widths
- Comments
- Formats
- Formulas
- Formulas And Number Formats
- Validation
- Values
- Values And Number Formats
- Operation Type: The paste special options to perform. Valid entries include None, Add, Subtract, Multiply, and Divide
- Skip Blanks: The paste special options to skip blanks. Valid entries are True or False
- Transpose: The paste special options to transpose the values. Valid entries are True or False
Notes:
- The standard Excel behavior for copy & paste / copy & paste special behaviors applies
- If Paste Type contains an invalid entry, the default All applies.
- If Operation Type contains an invalid entry, the default None applies.
- Range ( : ), Union ( , ) and Intersection ( ) operators can be used to define ranges
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- Error Number 1004: Method ‘Range’ of Object ‘_Worksheet’ failed
- The range is invalid or does not exist
- Error Number 1004: This action won’t work on multiple selections
- The range must be a single contiguous range
- Error Number 1004: The cell or chart you are trying to change is on a protected sheet. To make a change, unprotect the sheet. You might be requested to enter a password.
- The sheets are protected, and the action can’t be completed
- Error Number 13: Type mismatch
- The text strings provided in the Paste Type and Operation Type are not True or False values
Excel Range Select
Purpose: Selects the specified range.
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Sheet Name: Name of a sheet in workbook (e.g. Sheet1)
- Ranges: List of range references or named ranges contained on the sheet (e.g. B1:B10,A4:C4)
Notes:
- Range ( : ), Union ( , ) and Intersection ( ) operators can be used to define ranges
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- Error Number 1004: Method ‘Range’ of Object ‘_Worksheet’ failed
- The named ranges is invalid, or does not exist
Excel Sheet Copy
Purpose: Copies and worksheet into another workbook
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Sheets List: Name of sheets in the workbook (e.g. Sheet1,Sheet2). Multiple worksheet can be named with separator between
- Copy To File Name: Name of an open Excel workbook where worksheets to be copied (e.g. File Name.xlsx)
- Position: Position where the worksheets to be placed. Valid entires are Before, or After
- Sheet: Name of worksheet where the copied sheets are to be placed Before or After
- Separator:The character used to separate the Sheets List (e.g. a comma ( , ))
Notes:
- Where the Position parameter is an invalid entry, it will default to Before.
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
Excel Sheet Delete
Purpose: Deletes the listed Excel sheets
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Sheets List: List of sheet names to be deleted, split by a separator (e.g. Sheet1,Sheet2)
- Separator: The character used to separate the sheet names (e.g. a comma ( , ))
Notes:
- There must be at least one visible sheet at all times, otherwise an error occurs
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheets in the Sheet List are not all in the workbook
- Error Number 1004: A workbook must contains at least one visible worksheet
- Trying to delete all visible worksheets. There must be at least one visible worksheet.
Excel Sheet Existence Get
Purpose: Checks if a worksheet exists in a workbook
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Sheet Name: Name of the sheet to check existence for
- Return File Name: Name of an open Excel workbook to return the value to (e.g. File Name.xlsx)
- Return Sheet Name: Name of a sheet in workbook to return the value to (e.g. Sheet1)
- Return Cell: Name of a cell reference on the worksheet to return the value to (e.g. A1)
Notes:
- (None)
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- The cell name is not valid
- Error Number 1004: Method ‘Range’ of Object ‘_Worksheet’ failed
- The named ranges is invalid, or does not exist
Excel Sheet Hardcode
Purpose: Converts Excel worksheets to hardcoded values
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Sheets List: List of sheet names to be hardcoded, split by a separator (e.g. Sheet1,Sheet2)
- Separator: The character used to separate the sheet names (e.g. a comma ( , ))
Notes:
- (None)
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheets in the Sheet List are not all in the workbook
Excel Sheet Move
Purpose: Moves and worksheet into another workbook
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Sheets List: Name of sheets in the workbook (e.g. Sheet1,Sheet2). Multiple worksheet can be named with separator between
- Move To File Name: Name of an open Excel workbook where worksheets to be moved (e.g. File Name.xlsx)
- Position: Position where the worksheets to be placed. Valid entires are Before, or After
- Sheet: Name of worksheet where the moved sheets are to be placed Before or After
- Separator: The character used to separate the Sheets List (e.g. a comma ( , ))
Notes:
- Where the Position parameter is an invalid entry, it will default to Before.
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
Excel Sheet Name (Active) Get
Purpose: Returns the name of the active worksheet
Parameters:
- Return File Name: Name of an open Excel workbook to return the value to (e.g. File Name.xlsx)
- Return Sheet Name: Name of a sheet in workbook to return the value to (e.g. Sheet1)
- Return Cell: Name of a cell reference on the worksheet to return the value to (e.g. A1)
Notes:
- (None)
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- The cell name is not valid
Excel Sheet Name (By Position) Get
Purpose: Returns the name of the sheet in the nth position in the workbook.
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Sheet Number: The sheet number for which to return the worksheet name
- Return File Name: Name of an open Excel workbook to return the value to (e.g. File Name.xlsx)
- Return Sheet Name: Name of a sheet in workbook to return the value to (e.g. Sheet1)
- Return Cell: Name of a cell reference on the worksheet to return the value to (e.g. A1)
Notes:
- (None)
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The sheet number exceeds the number of sheets in the workbook
- The named sheet is not in the workbook
- The cell name is not valid
Excel Sheet Print
Purpose: Sends the named worksheets to the default printer
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Sheets List: Name of sheets in the workbook (e.g. Sheet1,Sheet2). Multiple worksheet can be named with separator between
- Separator: The character used to separate the Sheets List (e.g. a comma ( , ))
Notes:
- This action is intended for physical printing, as when printing to a PDF or File, the the automation may stop to confirm file name.
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
Excel Sheet Protect
Purpose: Protects or Unprotects named worksheets in a workbook
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Sheets List: Name of sheets in the workbook (e.g. Sheet1,Sheet2). Multiple worksheet can be named with separator between
- Type: Can be set to a single value of Protect, or Unprotect
- Password: The password to protect or unprotect the worksheet as a text string
- Separator: The character used to separate the Sheets List (e.g. a comma ( , ))
Notes:
- If the Type is not Protect or Unprotect, no action is undertaken
- The same password is applied to all the named worksheets
- An empty password string protects without a password
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- Error Number 1004: Method ‘Unprotect’ of object ‘_Worksheet’ failed
- The password provided for unprotecting the worksheet is incorrect
Excel Sheet Rename
Purpose: Rename worksheets in a workbook.
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Old Sheet List: Name of sheets in the workbook (e.g. Sheet1,Sheet2) to be renamed. Multiple worksheet can be named with separator between.
- New Sheet List: Text string of the new names worksheet names (e.g. Sheet3, Sheet4). Multiple names can be used with separator between.
- Separator: The character used to separate the Sheets List (e.g. a comma ( , ))
Notes:
- (None)
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- The Old Sheet List and New Sheet List contain different number of items
- Error Number 1004: That name is already taken. Try a different one.
- A worksheet with that name already exists
- Error Number 1004: You typed an invalid name for a sheet or chart
- The new name provided for the worksheet contains invalid characters
Excel Sheet Visibility Change
Purpose: Change visibility of listed sheets in a workbook
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Sheets List: List of sheet names to set visibility status, split by a separator (e.g. Sheet1,Sheet2)
- Status: Can be set to Visible, Hidden, or Very Hidden
- Separator: The character used to separate the sheet names (e.g. a comma ( , ))
Notes:
- There must be at least one visible sheet at all times
- If the Status is an invalid option, no changes are made
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheets in the Sheet List are not all in the workbook
- Error Number 1004: Unable to set the Visible property of the Worksheet class
- Trying to make all sheets Hidden or Very Hidden. There must be at least one visible worksheet.
Excel Sheet Visibility Get
Purpose: Checks the visibility status of the named worksheet
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Sheet Name: Name of the sheet to check existence for
- Return File Name: Name of an open Excel workbook to return the value to (e.g. File Name.xlsx)
- Return Sheet Name: Name of a sheet in workbook to return the value to (e.g. Sheet1)
- Return Cell: Name of a cell reference on the worksheet to return the value to (e.g. A1)
Notes:
- Return values are Visible, Hidden or Very Hidden
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- The cell name is not valid
- Error Number 1004: Method ‘Range’ of Object ‘_Worksheet’ failed
- The named ranges is invalid, or does not exist
Excel Slicer Change
Purpose: Changes the selected items in a Slice
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Slicer Name: Name of slicer in the workbook (e.g. Slicer_SlicerName)
- Select List: List of values to select in the Pivot Field (e.g. Value1,Value2). Each value is separated by the separator character below.
- Separator: The character used to separate the Select List (e.g. a comma ( , ))
Notes:
- Slicer names are always preceded with “Slicer_” within VBA
- Invalid selections are ignored
- If all selections are invalid, all items are selected
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- Error Number 5: Invalid call or argument
- Named slicer does not exist in the workbook
Excel Workbook Close
Purpose: Closes the named workbook
Parameters:
File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
Notes:
- Unless AutoSave is enabled for workbooks saved on OneDrive or SharePoint, the workbook closes without saving changes (use Excel Save to save changes before closing).
Common Errors:
- Error 9: Subscript out of range
- The named workbook is not open
Excel Workbook Existence Get
Purpose: Checks if a workbook is open in the current Excel application
Parameters:
- File Name: Name of the workbook to check for existence (e.g. File Name.xlsx)
- Return File Name: Name of an open Excel workbook to return the value to (e.g. File Name.xlsx)
- Return Sheet Name: Name of a sheet in workbook to return the value to (e.g. Sheet1)
- Return Cell: Name of a cell reference on the worksheet to return the value to (e.g. A1)
Notes:
- (None)
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- The cell name is not valid
- Error Number 1004: Method ‘Range’ of Object ‘_Worksheet’ failed
- The named ranges is invalid, or does not exist
Excel Workbook Name (Active) Get
Purpose: Returns the name of the active workbook
Parameters:
- Return File Name: Name of an open Excel workbook to return the value to (e.g. File Name.xlsx)
- Return Sheet Name: Name of a sheet in workbook to return the value to (e.g. Sheet1)
- Return Cell: Name of a cell reference on the worksheet to return the value to (e.g. A1)
Notes:
- (None)
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- The cell name is not valid
Excel Workbook Open
Purpose: Opens a named workbook
Parameters:
- File Path: The full file path of an Excel workbook (e.g. C:\Folder Path\File Name.xlsx)
- Read Only: Can be set to True, or False
- Update Links: Can be set to True, or False
- File Open Password: The password to open the file as a text string
- Modify Password: The password to open the file as a text string
Notes:
- Workbooks need to be opened to undertake any other actions on them.
- Passwords in the automation are viewable by anybody who can open the file.
Common Errors:
- Error Number 1004: Sorry, we couldn’t find [xxxxxxx]. Is it possible it was moved, renamed or deleted?
- The named workbook does not exist in that location or cannot be found.
- Error Number 13: Type mismatch
- A parameter requiring True or False contains an invalid entry
- Error Number 1004: The password you supplied is not correct. Verify that the CAPS LOCK key is off and be sure to use the correct capitalization.
- The File Open Password or Modify Password (if not opening as Read Only) is incorrect.
Excel Workbook Protect
Purpose: Protects or Unprotects a workbook
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Type: Can be set to a single value of Protect, or Unprotect
- Password: The password to protect or unprotect the worksheet as a text string
Notes:
- If the Type is not Protect or Unprotect, no action is undertaken
- A blank password for Protect will protect without a password
Common Errors:
- Error 9: Subscript out of range
- The named workbook is not open
- Error Number 1004: The password you supplied is not correct. Verify that the CAPS LOCK key is off and be sure to use the correct capitalization
- The password provided for unprotecting the workbook is incorrect
Excel Workbook Save
Purpose: Saves the named Excel Workbook
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Save Type: Can be set to Save, Save As, or Save Copy
- Save As Path: The file path to Save As or Save Copy (e.g. C:\Folder Path\New File Name.xlsx), leave blank for Save.
- File Type: Can be set to xlsx, xlsm, xlsb, csv, xls
Notes:
- Existing files already in the Save As Path are overwritten
- Where the Save Type is Save, no further arguments are required
- Save As Path only required for Save As or Save Copy
- File Type is only required for Save As
- If Save Type is invalid no action is taken
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- Error Number 1004: Method ‘SaveAs’ object of ‘_Workbook’ failed
- The File Type provided is invalid
Excel Workbook Sheets Count Get
Purpose: Counts the sheets in a workbook and returns the value back to a cell
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Return File Name: Name of an open Excel workbook to return the value to (e.g. File Name.xlsx)
- Return Sheet Name: Name of a sheet in workbook to return the value to (e.g. Sheet1)
- Return Cell: Name of a cell reference on the worksheet to return the value to (e.g. A1)
Notes:
- (None)
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The sheet number exceeds the number of sheets in the workbook
- The named sheet is not in the workbook
- The cell name is not valid
- Error Number 1004: Method ‘Range’ of Object ‘_Worksheet’ failed
- The range is invalid or does not exist
Excel Workbook Sheets List Get
Purpose: Lists the sheets in a workbook and returns the value to a list of cells
Parameters:
- File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Return File Name: Name of an open Excel workbook to return the value to (e.g. File Name.xlsx)
- Return Sheet Name: Name of a sheet in workbook to return the value to (e.g. Sheet1)
- Return Cell: Name of a cell reference on the worksheet to return the value to (e.g. A1)
Notes:
- (None)
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The sheet number exceeds the number of sheets in the workbook
- The named sheet is not in the workbook
- The cell name is not valid
- Error Number 1004: Method ‘Range’ of Object ‘_Worksheet’ failed
- The range is invalid or does not exist
File Available Get
Purpose: Checks if a file is available for editing, returns True/False to the worksheet.
Parameters:
- File Path: Full file path of the file to check availability for
- Return File Name: Name of an open Excel workbook to return the value to (e.g. File Name.xlsx)
- Return Sheet Name: Name of a sheet in workbook to return the value to (e.g. Sheet1)
- Return Cell: Name of a cell reference on the worksheet to return the value to (e.g. A1)
Notes:
- Return values are:
- True = File available for editing
- False = File is locked for editing
- Any other values = The error numbers (e.g. 76 = Supplied file path does not exist)
Common Errors:
- (None)
File Copy
Purpose: Copies a file
Parameters:
- File Path: A valid file path a file (e.g. C:\Folder Path\File Name.xlsx)
- Copy To File Path: A valid file path to copy the file to (e.g. C:\Folder Path\New File Name.xlsx)
Notes:
- (None)
Common Errors:
- Error Number 53: File not found
- File Path argument does not reference a file
- Error Number 76: Path not found
- The folder path for the copied file is not a valid folder path
- Error Number 70: Permission denied
- The Copy To File Path is locked and cannot be overwritten
File Delete
Purpose: Deletes a file
Parameters:
File Path: A valid file path a file (e.g. C:\Folder Path\File Name.xlsx)
Notes:
(None)
Common Errors:
- Error Number 53: File not found
- File Path argument does not reference a file
- Error Number 70: Permission denied
- The file is locked and cannot be overwritten.
File Existence Get
Purpose: Checks if a file exists, returns True/False to the worksheet.
Parameters:
- File Path: Full file path of the file to check existence for
- Return File Name: Name of an open Excel workbook to return the value to (e.g. File Name.xlsx)
- Return Sheet Name: Name of a sheet in workbook to return the value to (e.g. Sheet1)
- Return Cell: Name of a cell reference on the worksheet to return the value to (e.g. A1)
Notes:
- Return values are:
- True = File exists
- False = File does not exist
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- The cell name is not valid
File Move
Purpose: Moves or renames a file
Parameters:
- File Path: A valid file path a file (e.g. C:\Folder Path\File Name.xlsx)
- Move To File Path: A valid file path to move the file to (e.g. C:\Folder Path\New File Name.xlsx)
Notes:
- (None)
Common Errors:
- Error Number 53: File not found
- File Path argument does not reference a file
- The folder path of the Move To parameter is not a valid folder
- Error Number 75: Path/File access error
- The file is locked for this activity. It may already be open by another user.
- Error Number 58: File already exists
- The file in the Move To File Path already exists
File Open
Purpose: Opens the named file using the default application.
Parameters:
- File Path: A valid file path a file (e.g. C:\Folder Path\File Name.xlsx)
Notes:
- If the file cannot be opened, or does not exists, no error occurs
Common Errors:
- (None)
File Selection Get
Purpose: Gives user the ability to select a file using the File Open dialog. Returns the value to a cell.
Parameters:
- Title: Text to appear at the top of the dialog box
- Button Text: Text to appear in the dialog button
- Filter Description: Description for any filters applied
- Filter Extensions: File extension filters separated by semi-colons (e.g. *xlsx;*xlsm)
- Default Folder: The default folder path which opens which dialog appears (e.g. C:\Folder Path\)
- File Name Element: Determine which element of the file path to return. File = file name, Folder = folder path, Full = folder path and file name
- Return File Name: Name of an open Excel workbook to return the value to (e.g. File Name.xlsx)
- Return Sheet Name: Name of a sheet in workbook to return the value to (e.g. Sheet1)
- Return Cell: Name of a cell reference on the worksheet to return the value to (e.g. A1)
Notes:
- Where File Element Name is invalid, reverts to default of Full.
- If the user clicks Cancel, a blank cell value is returned to the cell.
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- The cell name is not valid
Folder Create
Purpose: Creates all the folders along a file path
Parameters:
- Folder Path: The full folder path to create (e.g. C:\Full Folder Path\To Create\)
Notes:
- Creates all folders and parent folders
Common Errors:
- (None)
Folder Existence Get
Purpose: Checks if a folder exists, returns True/False to the worksheet.
Parameters:
- Folder Path: Folder path to check existence for
- Return File Name: Name of an open Excel workbook to return the value to (e.g. File Name.xlsx)
- Return Sheet Name: Name of a sheet in workbook to return the value to (e.g. Sheet1)
- Return Cell: Name of a cell reference on the worksheet to return the value to (e.g. A1)
Notes:
- Return values are:
- True = Folder exists
- False = Folder does not exist
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- The cell name is not valid
Folder Files List Get
Purpose: Lists the files in a folder and sub folders
Parameters:
- Folder Path: A valid folder path (e.g. C:\Folder Path\)
- Include Subfolders: Declare if subfolders are to be included. Valid entries True or False
- Return File Name: Name of an open Excel workbook to return the value to (e.g. File Name.xlsx)
- Return Sheet Name: Name of a sheet in workbook to return the value to (e.g. Sheet1)
- Return Cell: Name of a cell reference on the worksheet to return the value to (e.g. A1)
Notes:
- If the folder cannot be opened, or does not exists, no error occurs
Common Errors:
- Error Number 9: Subscript out of range
- The named folder does not exist
- The named workbook is not open
- The named sheet is not in the workbook
- The cell name is not valid
- Error Number 13: Type mismatch
- A parameter requiring a True or False value has not been allocated a True or False value
Folder Open
Purpose: Opens the named folder
Parameters:
- Folder Path: A valid folder path (e.g. C:\Folder Path\)
Notes:
- If the folder cannot be opened, or does not exists, no error occurs
Common Errors:
- (None)
Folder Name Valid Get
Purpose: Checks if a text string could be a valid folder name
Parameters:
- Folder Path: Folder path to check existence for
- Return File Name: Name of an open Excel workbook to return the value to (e.g. File Name.xlsx)
- Return Sheet Name: Name of a sheet in workbook to return the value to (e.g. Sheet1)
- Return Cell: Name of a cell reference on the worksheet to return the value to (e.g. A1)
Notes:
- (None)
Common Errors:
- (None)
Folder Selection Get
Purpose: Gives user the ability to select a folder using the Folder Open dialog. Returns the value to a cell.
Parameters:
- Title: Text to appear at the top of the dialog box
- Button Text: Text to appear in the dialog button
- Default Folder: The default folder path which opens which dialog appears (e.g. C:\Folder Path\)
- Return File Name: Name of an open Excel workbook to return the value to (e.g. File Name.xlsx)
- Return Sheet Name: Name of a sheet in workbook to return the value to (e.g. Sheet1)
- Return Cell: Name of a cell reference on the worksheet to return the value to (e.g. A1)
Notes:
- If the user clicks Cancel, a blank cell value is returned to the cell.
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- The cell name is not valid
Folder Unzip
Purpose: To unzip a zip file to a folder
Parameters:
- Zip File Path: The full file path to a zip file (e.g. C:\Folder Path\File.zip)
- Folder Path: The folder path to unzip the files to (e.g. C:\Folder Path\)
Notes:
- The Folder Path must already exist
Common Errors:
- Error Number 91: Object variable or With bock variable not set
- The file path to the zip file does not exist
- The folder path does not already exist
Folder Zip
Purpose: To zip an existing folder
Parameters:
- Folder Path: The folder path to zip the files (e.g. C:\Folder Path\)
- Zip File Path: The full file path to create the zip file (e.g. C:\Folder Path\File.zip)
Notes:
- Zipping to a file extension other than .zip may cause unexpected behaviour
Common Errors:
- Error Number 91: Object variable or With bock variable not set
- The folder path does not already exist
Input Box Display
Purpose: Displays an input box to collect user input.
Parameters:
- Prompt: Text to appear as the Prompt of the message box
- Title: Text to appear in the Title of the message box
- Default Text: Default message to appear within the input box
- Input Type: Declares the data input type, valid entries are Formula, Number, Text, Logical
- Return File Name: Name of an open Excel workbook to return the value to (e.g. File Name.xlsx)
- Return Sheet Name: Name of a sheet in workbook to return the value to (e.g. Sheet1)
- Return Cell: Name of a cell reference on the worksheet to return the value to (e.g. A1)
Notes:
- Where the Input Type invalid defaults to Text
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- The cell name is not valid
Input Message Display
Purpose: Displays a message box and collects the users button click
Parameters:
- Prompt: Text to appear as the Prompt of the message box
- Title: Text to appear in the Title of the message box
- Button Style: Declare the buttons on the message box. Valid entries are OK, OK Cancel, Abort Retry Ignore, Yes No, Yes No Cancel, Retry Cancel
- Icon Style: Declare the type of message box icon. Valid entires are Critical, Question, Exclamation, Information, or None.
- Default Button: Declare button number is the default button on display, valid entries depend on the button style. (e.g. 2 = second button)
- Message Box Scope: Declare the type of message box, valid entries are Application, or System
- Return File Name: Name of an open Excel workbook to return the value to (e.g. File Name.xlsx)
- Return Sheet Name: Name of a sheet in workbook to return the value to (e.g. Sheet1)
- Return Cell: Name of a cell reference on the worksheet to return the value to (e.g. A1)
Notes:
- Message box scope settings:
- Application – Message box is displayed in front of the Excel application
- System – Message box is displayed in front of all applications
- If the Button Style is invalid, defaults to OK
- If the Icon Style is invalid, defaults to None
- If Default Button is invalid, defalts to 1
- If message box scope is invalid, defaults to Default
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- The cell name is not valid
Keyboard Press
Purpose: Simulates keyboard actions, including text and shortcut keys
Parameters:
- Keys: The list of key strokes to send
- Separator: The character used to separate the Keys list(e.g. a comma ( , ))
Notes:
- For any non-standard key including shortcuts, refer to this guide: https://learn.microsoft.com/en-us/office/vba/Language/Reference/user-interface-help/sendkeys-statement
- Leaving Excel in Edit Mode may cause unexpected errors.
Common Errors:
- Various – depending on actions.
Mouse Click
Purpose: Simulate mouse clicks
Parameters:
- Top (px): Mouse position from top in pixels
- Left (px): Mouse position from left in pixels
- Click type: Define the click type. Valid entries include, Left Single, Left Double, Right Single, None
Notes:
- Pixels vary by monitor and resolution settings. Therefore this can be unpredictable on different set-ups.
- Leaving Excel in Edit Mode may cause unexpected errors.
Common Errors:
- Various – depending on actions.
Outlook Email Create
Purpose: Sends emails with attachments
WARNING: Take care with this action as you could easily distribute the wrong information to the wrong people. Start by using Display as the Action parameter and review all emails before sending manually. Once you are 100% confident the process works correctly, then consider changing the Action parameter to Send.
Parameters:
- To: Distribution list of the individuals to send the e-mails to (e.g. [email protected]; [email protected])
- Cc: Distribution list of the individuals to Cc the e-mails to (e.g. [email protected]; [email protected])
- Bcc: Distribution list of the individuals to Bcc the e-mails to (e.g. [email protected]; [email protected])
- From: The email address to send the email from (e.g. [email protected])
- Subject: Text string to be used as the Subject
- Body HTML: HTML to be used as the message body. (e.g. Hi,<br /><br />This is my email.<br /><br />Kind regards,<br />Mark)
- Attachments List: File paths to attachments, split by a separator e.g. (C:\Folder Path\File Name.xlsx,C:\Folder Path\File Name.xlsx)
- Attachement Separator: The character used to separate the attachments lists (e.g. a comma ( , ))
- Action: The email action to perform. Valid entires are Display, Save, Send
Notes:
- The To, Cc, Bcc can all be blank. Atleast one must have a valid address if using the Send action.
- Where From is blank, the default account is used.
- Email addresses should be separated by semi colons ( ; )
- Body HTML must be included on a single line of text to operate correctly with the Automation Toolkit. Use HTML tags to create formatting.
- If no attachments required, leave Attachments List parameter blank.
- If Action is invalid no action is taken
Common Errors:
- Error Number -2147024893: Path does not exist. Verify the path is correct.
- One or more attachments listed has an invalid file path
- Error Number -2147467259: We need to know who to send this to. Make sure you enter at least one name.
- The To, Cc and Bcc fields are all blank when using the Send action.
Power Automate HTTP Request Send
Purpose: Send a HTTP request to trigger Power Automate flow using the When an HTTP Request is received trigger
Parameters:
- Method: The method defined in Power Automate, valid entries are GET, PUT, POST, PATCH, DELETE
- URL: The URL provided by Power Automate
Notes:
- Must be run when internet connection exists.
Common Errors:
- (None)
PowerPoint Break Links
Purpose: Breaks links to linked objects for the named presentation
Parameters:
- File Name: Name of an open PowerPoint presentation (e.g. File Name.pptx)
Notes:
- (None)
Common Errors:
- Error Number 429: ActiveX component can’t create object
- The PowerPoint application is not open
- Error Number -2147188160: Item [xxxx] not found in the Presentation collection.
- The named presentation is not open
PowerPoint Links Find & Replace
Purpose: Performs Find & Replace action on the file path of linked objects
Parameters:
- File Name: Name of an open PowerPoint presentation (e.g. File Name.pptx)
- Find Text:Text to find in the linked file path
- Replace Text: Text to replace in the linked file paths
Notes:
- File links can only be repointed to valid files which already exist
Common Errors:
- Error Number 429: ActiveX component can’t create object
- The PowerPoint application is not open
- Error Number -2147188160: Item [xxxx] not found in the Presentation collection.
- The named presentation is not open
PowerPoint Update Links
Purpose: Updates PowerPoint linked objects
Parameters:
- File Name: Name of an open PowerPoint presentation (e.g. File Name.pptx)
Notes:
- Links update faster when the source files are open
- There is no notification or verification if links have been updated
Common Errors:
- Error Number 429: ActiveX component can’t create object
- The PowerPoint application is not open
- Error Number -2147188160: Item [xxxx] not found in the Presentation collection.
- The named presentation is not open
PowerPoint Object Delete
Purpose: Deletes the named object from a slide
Parameters:
- File Name: Name of an open PowerPoint presentation (e.g. File Name.pptx)
- Slide Index: The slide number on which to paste the image (e.g. 1)
- Object Name: The name of the shape to delete
Notes:
- (None)
Common Errors:
- Error Number -2147188160: Item [x] not found in the Presentations collection. Perhaps you meant [x]
- The named presentation is not open
- Error Number -2147188160: Slides.Item : Integer out of range. [x] is not in Index’s valid range of [x] to [x].
- The Slide Index number is outside the range of available slides
- Error Number -2147188160: Item [xxxx] not found in the Shapes collection
- The named object does not exist on the slide
PowerPoint Object From Excel Paste
Purpose: Paste a range or chart from Excel into a PowerPoint slide
Parameters:
- Excel File Name: Name of an open Excel workbook (e.g. File Name.xlsx)
- Sheet Name: Name of a sheet in the workbook (e.g. Sheet1)
- Object Type: Declare the object type, valid entires are Range or Chart
- Object Name: The name or reference of the object (e.g. A1:D10 or Chart1)
- PowerPoint File Name: Name of an open PowerPoint presentation (e.g. File Name.pptx)
- Slide Index: The slide number on which to paste the image (e.g. 1)
- Paste Type: The type of paste to perform valid entries include:
- Picture
- Linked Picture
- Standard
- Table-Source
- Table-Destination
- Chart-Source
- Chart-Destination
- Embedded
- Text-Formatted
- Text-Plain
- Lock Aspect Ratio: True or False value to declare if the aspect ratio should be locked.
- Top (pts): The position from top in points to place the pasted item
- Left (pts): The position from left in points to place the pasted item
- Width (pts): The width in points of the pasted item
- Height (pts): The height in points of the pasted item. Ignored if Lock Aspect Ratio is set to True
Notes:
- Height is ignored when Lock Aspect Ratio is set to True. The height is calculated based on the width while maintaining the same image proportions.
- Where Lock Aspect Ration is an invalid entry, it reverts to the default value of True
Common Errors:
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- The cell name is not valid
- Error Number 1004: Method ‘Range’ of of object ‘_Worksheet’ failed
- Invalid range syntax of named range not found
- Error Number -2147024809: The items with the specified name wasn’t found.
- The named chart does not exist in the workbook
- Error Number -2147188160: Item [x] not found in the Presentations collection. Perhaps you meant [x]
- The named presentation is not open
- Error Number -2147188160: Slides.Item : Integer out of range. [x] is not in Index’s valid range of [x] to [x]
- The Slide Index number is outside the range of available slides
- Error Number -2147188160: Item [xxxx] not found in the Shapes collection
- The named object does not exist on the slide
- Error Number 13: Type Mismatch
- The Slide Index provided is not a whole number
- The Top, Left, Width, Height arguments are not numbers
- Error Number 429: ActiveX component can’t create object
- The PowerPoint application is not open
- Error Number -2147188160: Item [xxxx] not found in the Presentation collection.
- The named presentation is not open
PowerPoint Object Info Get
Purpose: Gets information about a PowerPoint object and returns it to a cell
Parameters:
- File Name: Name of an open PowerPoint presentation (e.g. File Name.pptx)
- Slide Index: The slide number on which to paste the image (e.g. 1)
- Object Name: The name of the object to get info about
- Info: The info to return. Valid entries include Top|Left|Right|Bottom|All
- Return File Name: Name of an open Excel workbook to return the value to (e.g. File Name.xlsx)
- Return Sheet Name: Name of a sheet in workbook to return the value to (e.g. Sheet1)
- Return Cell: Name of a cell reference on the worksheet to return the value to (e.g. A1)
Notes:
- All returns a comma separated list containing all the other elements
- Where an invalid Info parameter is provided, All is returned by default
Common Errors:
- Error Number -2147188160: Item [x] not found in the Presentations collection. Perhaps you meant [x]
- The named presentation is not open
- Error Number -2147188160: Slides.Item : Integer out of range. [x] is not in Index’s valid range of [x] to [x].
- The Slide Index number is outside the range of available slides
- Error Number -2147188160: Item [xxxx] not found in the Shapes collection
- The named object does not exist on the slide
- Error Number 9: Subscript out of range
- The named workbook is not open
- The named sheet is not in the workbook
- The cell name is not valid
- Error Number 1004: Method ‘Range’ of Object ‘_Worksheet’ failed
- The named ranges is invalid, or does not exist
PowerPoint Object Rename
Purpose: Renams an object on a PowerPoint slide
Parameters:
- File Name: Name of an open PowerPoint presentation (e.g. File Name.pptx)
- Slide Index: The slide number on which to paste the image (e.g. 1)
- Old Object Name: The name of the object to rename
- New Object Name: The new object name to use
Notes:
- Duplicate shape names are permitted in PowerPoint. Take care to ensure any shapes used in automations have unique names
Common Errors:
- Error Number -2147188160: Item [x] not found in the Presentations collection. Perhaps you meant [x]
- The named presentation is not open
- Error Number -2147188160: Slides.Item : Integer out of range. [x] is not in Index’s valid range of [x] to [x].
- The Slide Index number is outside the range of available slides
- Error Number -2147188160: Item [xxxx] not found in the Shapes collection
- The named object does not exist on the slide
- Error Number-2147024809: the specified value is out of range
- The object name is not valid
PowerPoint Object Text Change
Purpose: Inserts text into a PowerPoint object
Parameters:
- File Name: Name of an open PowerPoint presentation (e.g. File Name.pptx)
- Slide Index: The slide index containing object (e.g. 1)
- Object Name: Name of object to insert text into (e.g. Title1)
- New Text: The text to enter into the named object.
Notes:
- (None)
Common Errors:
- Error Number -2147188160: Slides.Item : Integer out of range. [x] is not in Index’s valid range of [x] to [x]
- The Slide Index number is outside the range of available slides
- Error Number -2147188160: Item [xxxx] not found in the Shapes collection
- The named object does not exist on the slide
- Error Number 13: Type Mismatch
- The Slide Index provided is not a whole number
- Error Number 429: ActiveX component can’t create object
- The PowerPoint application is not open
- Error Number -2147188160: Item [xxxx] not found in the Presentation collection.
- The named presentation is not open
PowerPoint PDF Save
Purpose: Saves the Presentation as a PDF
Parameters:
- File Name: Name of an open PowerPoint presentation (e.g. File Name.pptx)
- PDF File Path: The full file path to save the PDF (e.g. C:\Folder Path\File Name.pdf)
Notes:
- (None)
Common Errors:
- Error Number 429: ActiveX component can’t create object
- The PowerPoint application is not open
- Error Number -2147188160: Item [xxxx] not found in the Presentation collection.
- The named presentation is not open
- Error Number -2147467259: Automation error. Unspecified error
- The file path for the PDF is invalid
PowerPoint Presentation Close
Purpose: Closes the named presentation
Parameters:
- File Name: Name of an open PowerPoint presentation (e.g. File Name.pptx)
Notes:
- Presentation closes without saving changes (use PowerPoint Save to save changes before closing).
Common Errors:
- Error Number 429: ActiveX component can’t create object
- The PowerPoint application is not open
- Error Number -2147188160: Item [xxxx] not found in the Presentation collection.
- The named presentation is not open
PowerPoint Presentation Open
Purpose: Opens a named PowerPoint presentation
Parameters:
- File Path: The full file path of an Excel workbook (e.g. C:\Folder Path\File Name.pptx)
- Read Only: Can be set to True|False
- File Open Password: The password to open the file as a text string
Notes:
- Presentations need to be opened to undertake any other actions on them.
- PowerPoint will open duplicate presentations, so file management is important to ensure only one instance of the file is open.
- Passwords in the automation are viewable by anybody who can open the file.
Common Errors:
- Error Number -2147024894: Automation error. The system cannot find the path specified.
- The named presentation does not exist in that location or cannot be found.
- Error Number 13: Type mismatch
- A parameter requiring a True or False value has not been allocated a True or False value
- Error Number -2147467259: Presentations.Open : Reenter the &password required to open files:
- The File Open Password is incorrect.
PowerPoint Presentation Save
Purpose: Saves a PowerPoint Presentation
Parameters:
- File Name: Name of an open PowerPoint presentation (e.g. File Name.pptx)
- Save Type: Declare the save type, valid entires are Save, Save As, Save Copy
- Save As Path: The file path to Save As or Save Copy (e.g. C:\Folder Path\New File Name.pptx)
Notes:
- Where the Save Type is Save, a Save As Path is not required
- Save As Path only required for Save As or Save Copy
- If Save Type is invalid a Save is performed
Common Errors:
- Error Number 429: ActiveX component can’t create object
- The PowerPoint application is not open
- Error Number -2147188160: Item [xxxx] not found in the Presentation collection.
- The named presentation is not open
- Error Number -2147467259: Presentation.SaveAs : An error occurred wile PowerPoint was saving the file
- Invalid Save As file path
PowerPoint Slide Add
Purpose: Adds PowerPoint slides
Parameters:
- File Name: Name of an open PowerPoint presentation (e.g. File Name.pptx)
- Count: The number of slides to add
Notes:
- (None)
Common Errors:
- Error Number 13: Type Mismatch
- The count provided is not a whole number
- Error Number -2147188160: Item [xxxx] not found in the Presentation collection.
- The named presentation is not open
PowerPoint Slide Delete
Purpose: Deletes PowerPoint slides
Parameters:
- File Name: Name of an open PowerPoint presentation (e.g. File Name.pptx)
- Slide Index List: List of slide index to delete (e.g. 1,4)
- Separator: The character used to separate the Slide Index List (e.g. a comma ( , ))
Notes:
- Slides are deleted from end of the Slide Index List to start. Because if an earlier slide is deleted, the Index number may change for subsequent slides. Therefore, ensures slide index numbers is sequential order.
Common Errors:
- Error Number -2147188160: Slides.Item : Integer out of range. [x] is not in Index’s valid range of [x] to [x]
- The Slide Index number is outside the range of available slides
- Error Number -2147188160: Item [xxxx] not found in the Shapes collection
- The named object does not exist on the slide
- Error Number 13: Type Mismatch
- The Slide Index provided is not a whole number
- Error Number 429: ActiveX component can’t create object
- The PowerPoint application is not open
- Error Number -2147188160: Item [xxxx] not found in the Presentation collection.
- The named presentation is not open
PowerPoint Slide Move
Purpose: Move PowerPoint slides
Parameters:
- File Name: Name of an open PowerPoint presentation (e.g. File Name.pptx)
- Slide Index: A slide index to move (e.g. 1)
- Move To Index: A slide index to move to (e.g. 5)
Notes:
- (Note)
Common Errors:
- Error Number -2147188160: Slides.Item : Integer out of range. [x] is not in Index’s valid range of [x] to [x]
- The Slide Index number is outside the range of available slides
- Error Number 13: Type Mismatch
- The Slide Index provided is not a whole number
- Error Number 429: ActiveX component can’t create object
- The PowerPoint application is not open
- Error Number -2147188160: Item [xxxx] not found in the Presentation collection.
- The named presentation is not open
PowerPoint Slide Select
Purpose: Selects a PowerPoint slide
Parameters:
- File Name: Name of an open PowerPoint presentation (e.g. File Name.pptx)
- Slide Index: The slide number to select (e.g. 1)
Notes:
- (None)
Common Errors:
- Error Number -2147188160: Slides.Item : Integer out of range. [x] is not in Index’s valid range of [x] to [x]
- The Slide Index number is outside the range of available slides
- Error Number 13: Type Mismatch
- The Slide Index provided is not a whole number
- Error Number 429: ActiveX component can’t create object
- The PowerPoint application is not open
- Error Number -2147188160: Item [xxxx] not found in the Presentation collection.
- The named presentation is not open
PowerPoint Table Margins Change
Purpose: Changes the cell margins of the named table
Parameters:
- File Name: Name of an open PowerPoint presentation (e.g. File Name.pptx)
- Slide Index: The slide number on which to paste the image (e.g. 1)
- Table Name: The name of the table to change margins for
- Top: The top margin in cm
- Left: The left margin in cm
- Right: The right margin in cm
- Bottom: The bottom margin in cm
Notes:
Common Errors:
- Error Number -2147188160: Item [x] not found in the Presentations collection. Perhaps you meant [x]
- The named presentation is not open
- Error Number -2147188160: Slides.Item : Integer out of range. [x] is not in Index’s valid range of [x] to [x].
- The Slide Index number is outside the range of available slides
- Error Number -2147188160: Item [xxxx] not found in the Shapes collection
- The named object does not exist on the slide
- Error Number 13: Type mismatch
- The Top, Left, Right, Bottom paramters do not include valid numbers
Word Document Close
Purpose: Closes the named document
Parameters:
- File Name: Name of an open Word document (e.g. File Name.docx)
Notes:
- Document closes without saving changes (use Word Save to save changes before closing).
Common Errors:
- Error Number 429: ActiveX component can’t create object
- The Word application is not open
- Error Number 4160: Bad file name
- The named document is not open
Word Document Open
Purpose: Opens a named Word document
Parameters:
- File Path: Name of an open Word document (e.g. C:\Folder Path\File Name.docx)
- Read Only: Can be set to True or False
- File Open Password: The password to open the file as a text string
Notes:
- If automatic links are contained in the document the “Update Link” dialog will appear. Set all links to manual by changing the switch \a to \m to run with the Automation Toolkit.
Common Errors:
- Error Number 5174: Sorry, we couldn’t find you file. Was it moved, renamed or deleted?
- The named document does not exist in that location or cannot be found.
- Error Number 13: Type mismatch
- A parameter requiring a True or False value has not been allocated a True or False value
- Error Number 5408: The password is incorrect. Word cannot open the document.
- The File Open Password is incorrect.
Word Document Save
Purpose: Saves a Word Document
Parameters:
- File Name: Name of an open Word document (e.g. File Name.docx)
- Save Type: Can be set to Save|Save As
- Save As Path: The file path to Save As or Save Copy (e.g. C:\Folder Path\New File Name.docx)
Notes:
- Where the Save Type is Save, a Save As Path is not required
- If Save Type is invalid a Save is performed
- Word does not have a Save Copy method like Excel and PowerPoint
Common Errors:
- Error Number 429: ActiveX component can’t create object
- The Word application is not open
- Error Number 5174: Sorry, we couldn’t find you file. Was it moved, renamed or deleted?
- The named document does not exist in that location or cannot be found.
- Error Number 5152: This is not a valid file name. Try one of the following: Check the path to make sure it is typed correctly. Select a file for the list of files and folders.
- The folder path used for the Save As is not valid
- Error Number 5153: Word cannot give a document the same name as an open document. Type a different name for the document you want to save.
- A file with the Save As name is already open
Word Links Break
Purpose: Breaks links to linked objects for the named document
Parameters:
- File Name: Name of an open Word document (e.g. File Name.docx)
Notes:
- (None)
Common Errors:
- Error Number 429: ActiveX component can’t create object
- The Word application is not open
- Error Number 4160: Bad file name
- The named document is not open
Word Links Update
Purpose: Updates the linked objects in the document
Parameters:
- File Name: Name of an open Word document (e.g. File Name.docx)
Notes:
- Links update faster when the source files are opened. Use Excel Open to open the linked workbooks.
Common Errors:
- Error Number 429: ActiveX component can’t create object
- The Word application is not open
- Error Number 4160: Bad file name
- The named document is not open
Word PDF Save
Purpose: Saves the Document as a PDF
Parameters:
- File Name: Name of an open Word document (e.g. File Name.docx)
- PDF File Path: The full file path to save the PDF (e.g. C:\Folder Path\File Name.pdf)
Notes:
- (None)
Common Errors:
- Error Number 429: ActiveX component can’t create object
- The Word application is not open
- Error Number 4160: Bad file name
- The named document is not open
- Error Number -2147467259: The directory name isn’t valid
- The folder path for the PDF is invalid
- Error Number -214767259: We can’t save this file because it’s read-only. To keep your changes, you’ll need to save the document with a new name or in a different location.
- The PDF with that file path is already open
Web Hyperlink Follow
Purpose: Follows a url through the default browser
Parameters:
- Hyperlink: The URL to follow
Notes:
- (None)
Common Errors:
- (None)
Discover other articles:
