MS Excel Functions Library Objects

See Using the Microsoft Office Library.

Function / Event

Return Value

Description

Syntax

Copy data from one Excel Sheet to another at the specified row

None

Copies the specified rows from one Excel file to another Excel file. The function pastes the copied rows to the destination Excel file from the starting row and column number specified in the syntax.

Copy Data from Excel file <Source File Path><Source Sheet Name> <Start Column> <End Column> <Start Row Number> <End Row Number> into <Destination File Path> <Destination Sheet Name> at <Destination Column> <Row Number>

Note: You must specify the complete path of your source file and the file name in the <Source File Path> parameter.

For example, if your source file is located at C:\Automation Studio\Designer Functions, your file name is CopyRows.xlsx, the value of the <Source File Path> parameter will be:

C:\Automation Studio\Designer Functions\CopyRows.xlsx

Similarly, you must specify the complete path of your destination file along with the file name in the <Destination File Path> parameter.

Copy Rows from One Excel to Another Excel

None

Copies the specified rows from one Excel file to another Excel file. The function pastes the copied rows to the destination Excel file from the starting row and column number specified in the syntax.

Copy Data from Excel file <Source File Path><Source Sheet Name> <Start Column> <End Column> <Start Row Number> <End Row Number> into <Destination File Path> <Destination Sheet Name> at <Destination Column> <Row Number>

Note: You must specify the complete path of your source file and the file name in the <Source File Path> parameter.

For example, your source file is located at C:\Automation Studio\Designer Functions, and your file name is CopyRows.xlsx. The value of the <Source File Path> parameter will be:

C:\Automation Studio\Designer Functions\CopyRows.xlsx

Similarly, you must specify the complete path of your destination file along with the file name in the <Destination File Path> parameter.

Get Active Excel Cell Value

Text

Retrieves a cell value from a specified sheet in an active Excel worksheet.

Get Active Excel <Sheet Name> Cell (<Column> : <Row>) Value

Get Active Excel Cells Range

List of Row

Retrieves a list of rows with values from a specified sheet in the active Excel worksheet within a specified range of cells.

Get Active Excel <File Name> <Sheet Name> Cells Ranges <Start Row> <Start Column> <Row Count> <Column Count>

Get Active Excel Name

Text

Retrieves the name of an active Excel worksheet.

Get Active Excel Name

Get All Sheets from the Active Excel Document

List of Text

Retrieves the names of all sheets in an active Excel worksheet.

Get All Sheets from Excel <File Name>

Get All Sheets from the Excel Document

List of Text

Retrieves the names of all sheets in a specified Excel worksheet by its full path.

Get All Sheets from the Excel Document

Get Excel Cell Value

Text

Retrieves a cell value from a specified sheet in a specified Excel file by its full name.

Get Excel <FileName> <SheetName> Cell (<Column> : <Row>) Value

Get Excel Cells Range

List of Row

Retrieves a list of rows with values from a specified range of cells in a specified Excel sheet.

Get Excel <File Name> <Sheet Name> Cells Ranges <Start Row> <Start Column> <Row Count> <Column Count>

Get Excel Rows Count

Integer

Returns the row count of a specific column in an Excel sheet. The function counts only the non-blank rows in a column. Make sure that at least one cell in the specified column contains a value.

Get Excel Rows Count <File Path> <Sheet Name> <Column Name>

Inject And Run Excel Macro

-

Injects and runs the given VBA script in the specified Excel file by the full path. The Macro Name parameter is the name of the script. The Visible parameter indicates whether Excel is open while the function runs (if true, then the process is visible and the Excel application is visible in the taskbar). The Excel worksheet must be macro-enabled for this function to work.

The script opens and runs in Excel, and then exits. The script is not saved in Excel.

Inject And Run Excel Macro <File Path> <VBA Script> <Macro Name> <Visible>

Run Excel Macro

-

Runs the existing macro with parameters in the specified Excel file by its full path. The Visible parameter indicates whether to Excel should be visible while it is running (if true, process is visible and Excel application is visible in the taskbar). The Excel worksheet must be macro-enabled for this function to work.

Run Excel Macro <File Path> <Macro Name> <Visible> [<Parameters>, … ]

Set Active Excel Cell Value

-

Sets a cell value in a specified sheet in an active Excel worksheet.

Set Active Excel <Sheet Name> Cell ( <Column> : <Row> ) <Value>

Set Active Excel Cells Values

-

Sets values to a specified sheet within a range of cells in an active Excel worksheet.

You can add values for up to 256 cells in a single function call.

When assigning values use the following syntax:

Use || to separate columns/rows and values.

Use ||| as a separator between cells.

If you need to see an empty value in cell, enter a space as the value.

For example, to enter a space in cell A1 and ValueX in cell B1, use this syntax for the Values field: A1|| |||B1||ValueX

Set Active Excel <Sheet Name> <Values>

Set Excel Cell Value

---

Sets a cell value in a specified sheet in a specified Excel file by its full name.

Set Excel <FileName> <SheetName> Cell ( <Column> : <Row> ) <Value>

Set Excel Cell Values ---

Sets values in a specified range of cells in a specified sheet in given Excel file by its full name.

You can add values for up to 256 cells in a single function call.

When assigning values use the following syntax:

Use || to separate columns/rows and values.

Use ||| as a separator between cells.

If you need to see an empty value in cell, enter a space as the value.

For example, to enter a space in cell A1 and ValueX in cell B1, use this syntax for the Values field: A1|| |||B1||ValueX

Set Excel <FileName> <SheetName> <Values>