Get Cell
Returns the text contained in a specified cell of a worksheet from an established Excel session. 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.
Declaration
<AMEXCELGETCELL SESSIONNAME="text" RESULTVARIABLE="text" CELLROW="text" CELLREF="text" CELLCOLUMN="text" WORKSHEET="text">
Example
This example 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>
See Also: Create Workbook, Open Workbook, Close Workbook, Add Worksheet, Activate Worksheet, Set Cell, Cells to Dataset, Dataset to Cells
|
|
AWE'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. Excel objects run in the context of the user executing them. If EFT is running as a Local System, then the Excel object is executed using the Local System profile. Before using an Excel action in Event Rules, refer to Globalscape Knowledgebase article #11089 for important information.
This action is only useful in conjunction with other Excel actions. It is not possible to use AWE's Excel actions on a spreadsheet that was not opened by the Open Workbook action or created by the Create Workbook action.
|
General Tab
|
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 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.
|