Get Cell Action Icon

Get Cell

Declaration

<AMEXCELGETCELL SESSIONNAME="text" RESULTVARIABLE="text" CELLROW="text" CELLREF="text" CELLCOLUMN="text" WORKSHEET="text">

See Also

Activate Cell | Activate Worksheet | Add Worksheet | Cells to Dataset | Close Workbook | Create Workbook | Dataset to Cells Action | Get Active Cell | Get Active Worksheet | Get Cell | Open Workbook | Set Cell

Description

Returns the text contained in a specified cell of a worksheet from an established Excel session.

IMPORTANT: AutoMate's Excel actions use Microsoft's Excel automation engine to perform their work. Therefore, Microsoft Excel must be licensed and installed on the system in order for these actions to work.

Practical Usage

Used to retrieve the contents of a cell in a Microsoft Excel document that was previously created using the Create Workbook action or opened using the Open Workbook action.

NOTE: This action is only useful in conjunction with other Excel actions found in AutoMate. It is not possible to use Automate's Excel actions on a spreadsheet that was not opened by the Open Workbook action or created by the Create Workbook action.

Parameters

General Properties

Property

Type

Required

Default

Markup

Description

Session Name

Text

Yes

ExcelSess1

SESSION="ExcelSess7"

The name of the session to associate with this Excel action. Numerous sessions can exist within a single task allowing several spreadsheets to be open simultaneously. If working with only one document, this can remain at the default session name, which is Excelsess1.

Populate Variable

Text

Yes

(Empty)

RESULTVARIABLE="myvar"

The name of the AutoMate variable that should be populated with the contents of the desired cell at runtime.

Row

Number

No

1

CELLROW="3"

The row of the cell where the data should be retrieved. If this parameter is specified, the CELLCOLUMN parameter must also be specified.

Column

Number

No

1

CELLCOLUMN="2

The column of the cell where the data should be retrieved. If this parameter is specified, the CELLROW parameter must also be specified.

Cell Reference

Text

No

A1

CELLREF="B3"

Specifies the reference of the cell (i.e. B3 or C2) where the data should be retrieved. This is an alternate method to specifying the row and column of the desired cell. If this parameter is used, the CELLROW and CELLCOLUMN parameters are ignored.

Use Specific Worksheet

Text

No

3

WORKSHEET="Sheet4"

If enabled, indicates that the data will be retrieved from a specific worksheet. The worksheet name can be entered in the provided text box. If disabled or omitted, the current active worksheet will be used. The default option is set to Use Active Worksheet.

Use Formatted Value

Yes/No

No

No

FORMATTEDVALUE="YES"

Excel allows you to use formatting on individual cells or rows allowing you to apply a defined format to cells that meet specific criteria (i.e. date, time or currency formats). If set to YES, specifies that formatted values will be retrieved. If set to NO (default),the non-formatted the text value will be retrieved.

Description Properties

The Description tab allows you to customize the text description of any step as it appears in the Task Builder's Steps Pane.

More on setting custom step description

Error Causes Properties

The Error Causes tab properties lets you instruct a task step to react only to specific errors or ignore certain errors that should cause it to fail.

More on Error Causes properties

On Error Properties

The On Error tab properties lets you determine what the task should do if a particular step encounters an error as defined in the Error Causes properties.

More about On Error properties

Additional Notes

Expressions, Variables & Functions

A percent sign is used as a special character in AutoMate to indicate the beginning and end of an expression. This allows variables, functions and other expressions to be entered in any text parameter of a task's properties. For example: %1+1% inside a task will resolve to 2 at runtime. A more elaborate example is %FileDateTime(myFile)% which results to the date/time of myFile. To help construct expressions, you can open Expression Builder by clicking the Insert Expression (%) button or by pressing F2.

More on expressions

More on variables

More on functions

More on extended functions
More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

 

Description: This sample task opens an existing Excel document, retrieves the data contained in row 1/column1 of the active worksheet and populates a variable with the results. A message box is then used to display the value. In order for this task to work, make sure to edit the properties of the 'Open Workbook' action (step 2) to point to a valid Excel file that contains data in row 1 / column 1.

 

<AMVARIABLE NAME="myVar"></AMVARIABLE>

<AMEXCELOPENWORKBOOK WORKBOOK="C:\Temp\myexceldocument.xlsx" />

<AMEXCELGETCELL RESULTVARIABLE="myVar" CELLROW="1" CELLCOLUMN="1" />

<AMSHOWDIALOG WINDOWTITLE="CELL VALUE">The value of Row 1 / Column 1 is %myVar%.</AMSHOWDIALOG>

 

↑ Top of Page