OpenDocument Spreadsheet - Select cell(s)
Declaration
<AMODS ACTIVITY="activate_cell" SESSION="text" CONNECTBY="create_workbook" WORKBOOK="text" WORKBOOKTEMPLATE="text" TEMPLATEPASSWORD="text (encrypted)" OVERWRITE="YES/NO" OPENPASSWORD="text (encrypted)" SAVETYPE="text (options)" DESTINATION="text" OVERWRITEDESTINATION="YES/NO" CELLREF="text" ACTION="text (options)" CELLROW="text" CELLCOLUMN="text" UPPERLEFTREF="text" LOWERRIGHTREF="text" UPPERLEFTROW="text" UPPERLEFTCOLUMN="text" LOWERRIGHTROW="text" LOWERRIGHTCOLUMN="text" WORKSHEET="text /">
Description
Selects a single cell or multiple cells, ranges, rows or columns within the currently active worksheet.
Practical usage
Often used to select cells, ranges, rows, or columns, for example, to perform actions on the selection (for example, format the data or insert values) during subsequent steps. Be aware that this activity works only on the active worksheet. To activate a specific worksheet, use the OpenDocument Spreadsheet - Activate worksheet activity.
Parameters
Resource
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Resource | --- | --- | --- | --- | Indicates where the source
workbook document should originate from. The available options are:
NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes. |
Resource - File
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Get document by | Text (options) | Yes, if Resource is set to File | Open |
|
Specifies
whether to perform this activity on an existing document
or a new one. This parameter is only active if the Resource parameter is set to File. The available options
are:
|
File name | Text | Yes | (Empty) | WORKBOOK="C:\Temp\fileName.xls" | If Get document by is set to Open, specifies the path and file name of the document to open. If Get document by is set to Create, specifies the path and file name in which to save the newly created document. |
Password to open (optional) | Text | No | (Empty) | OPENPASSWORD="encrypted" | The password required to open the document if it is password protected. This parameter is only active if Get document by is set to Open, or if Get document by is set to Create and Create from template is selected. |
On completion | Text (options) | No | Save |
|
Specifies
what to do with the document upon completion of this activity.
The available options are:
|
File | Text | No | (Empty) | DESTINATION="c:\temp\dest.xls" | The path and file name of the file in which changes will be saved. Click the folder icon to open a standard Explorer dialog in order to navigate to the desired file or simply enter the path and file name in the provided text box. This parameter is only active if On completion is set to Save as. |
Overwrite if workbook already exists | Yes/No | No | No | OVERWRITE="YES" | If selected, the saved workbook will overwrite any workbook with the same name that exists in the destination. If disabled (default), an existing workbook with the same name will not be overwritten, however, an error will occur during runtime as a result of matching file names. This parameter is only active if On completion is set to Save as, and/or if Get document by is set to Create. |
Create from template | Text | No | No | WORKBOOKTEMPLATE="C:\Temp\file.xls" | If enabled, specifies the path and file name of a template file that already has preferred formatting in which to base the new workbook on. A template can include formatting, styles, standardized text such as page headers and row and column labels. This parameter is active only if Get document by parameter is set to Create. This parameter is disabled by default. |
Overwrite if workbook already exists | Yes/No | No | No | OVERWRITEDESTINATION="YES" | If selected, the saved workbook will overwrite any workbook with the same name that exists in the destination. If disabled (default), an existing workbook with the same name will not be overwritten, however, an error will occur during runtime as a result of matching file names. This parameter is only active if Get document by is set to Create. |
Resource - Session
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Session | Text | Yes, if Resource is set to Session | OPENDOCSession1 | SESSION="mySession" | The name of an existing session to associate this activity with. The default session name is OPENDOCSession1. This parameter is active only if Resource is set to Session. |
Cell
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Select | Text (options) | Yes | Cell by reference |
|
Specifies
the method in which to activate the cells. The available options
are:
|
Cell reference | Text | Yes, if Select is set to Cell by reference | (Empty) | CELLREF="B3" | The reference of the cell to activate (for example, A1 or B4). This parameter is active only if the Select parameter is set to Cell by reference. |
Row | Number | Yes, if Select is set to Cell by position | 1 | CELLROW="3" | The row number of the cell to activate. This value will be used along with the value entered in the Column parameter in order to reference a specific cell. This parameter is active only if the Select parameter is set to Cell by position. |
Column | Number | Yes, if Select is set to Cell by position | 1 | CELLCOLUMN="2" | The column number of the cell to activate. This value will be used along with the value entered in the Row parameter in order to reference a specific cell. This parameter is active only if the Select parameter is set to Cell by position. |
Upper left cell | Text | Yes, if Select is set to Range of cells by reference | (Empty) | UPPERLEFTREF="A1" | The reference of the upper left cell in the range of cells to activate (for example, A1 or B4). This value will be used along with the value entered in the Lower left cell parameter in order to reference a specific cell. This parameter is active only if the Select parameter is set to Range of cells by reference. |
Lower right cell | Text | Yes, if Select is set to Range of cells by reference | (Empty) | LOWERRIGHTREF="C5" | Specifies the reference of the lower right cell in the range of cells to activate. This parameter is active only if the Select parameter is set to Range of cells by reference. |
Upper left cell row | Number | Yes, if Select is set to Range of cells by position | (Empty) | UPPERLEFTROW="1" | Specifies the row of the upper left cell in the range of cells to activate. This parameter is active only if the Select parameter is set to Range of cells by position. |
Upper left cell column | Number | Yes, if Select is set to Range of cells by position | (Empty) | UPPERLEFTCOLUMN="1" | Specifies the column of the upper left cell in the range of cells to activate. This parameter is active only if the Select parameter is set to Range of cells by position. |
Lower right cell row | Number | Yes, if Select is set to Range of cells by position | (Empty) | LOWERRIGHTROW="14" | The row of the lower right cell in the range of cells to activate. This parameter is active only if the Select parameter is set to Range of cells by position. |
Lower right cell column | Number | Yes, if Select is set to Range of cells by position | (Empty) | LOWERRIGHTCOLUMN="3" | The column of the lower right cell in the range of cells to activate. This parameter is active only if the Select parameter is set to Range of cells by position. |
Examples
- Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
- To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.
Description
This sample task selects a cell in a worksheet.
<AMODS ACTIVITY="activate_cell" CONNECTBY="create_workbook" WORKBOOK="C:\temp\Employees.xls" SAVETYPE="save_as" DESTINATION="C:\temp3\newFile.xls" OVERWRITEDESTINATION="YES" CELLREF="A1" />