OpenDocument Spreadsheet - Delete Rows/Columns
Declaration
<AMODS ACTIVITY="delete_row_column" WORKBOOK="text" OPENPASSWORD="text (encrypted)" SAVETYPE="text (options)" DESTINATION="text" OVERWRITEDESTINATION="YES/NO" INDEX="Number" TOTALCOUNT="Number" WORKSHEET="text" />
Description: Deletes one or more rows/columns in the specified worksheet or clears the contents of one or more rows/columns. This activity can be executed individually or with a group of other OpenDocument Spreadsheet activities linked to an established session.
Practical Usage
Provides a way to manage rows and columns in a worksheet.
Resource Parameters
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
Resource |
--- |
--- |
--- |
--- |
Indicates where the source document should originate from. This is a design mode parameter used only during task construction and configuration, thus, comprises no markup. The available options are:
|
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 the Resource parameter is set to Session. |
Get document by |
Text (options) |
Yes if Resource is set to File |
Open |
|
Specifies whether this activity will be performed on an existing document or on a new one. This parameter is active only if the Resource parameter is set to File. The available options are:
|
File name |
Text |
Yes |
(Empty) |
WORKBOOK="C:\Temp\fileName.xls" |
If the Get document by parameter is set to Open, specifies the path and filename of the document in which to open. If the Get document by parameter is set to Create, specifies the path and filename in which to save the newly created document. |
Password to open (optional) |
Text |
Yes if Get document byparameter is set toOpen |
(Empty) |
OPENPASSWORD="encrypted" |
The password required to open the document if it is password protected. This parameter is active only if the Get document by parameter is set to Open. |
Create from template |
Text |
Yes if Get document by parameter is set to Create |
No |
WORKBOOKTEMPLATE=
|
If enabled, specifies the path and filename 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 the Get document by parameter is set to Create. It is disabled by default. |
On completion |
Text (options) |
No |
Save |
|
Specifies what to do with the document upon completion of this activity. The available options are:
|
File |
Text |
Yes if On completion parameter is set to Save as |
(Empty) |
DESTINATION="c:\temp\dest.xls" |
The path and filename of the file in which changes will be saved. Click the folder icon to open a standard Explorer dialog to navigate to the desired file or simply enter the path and filename in the provided text box. |
Overwrite if workbook already exists |
Yes/No |
Yes if On completion parameter is set to Save as |
No |
OVERWRITE="YES" |
If set to YES, the newly created workbook will overwrite any workbook with the same name that exists in the destination. If set to NO (default), an existing workbook with the same name will not be overwritten, however, an error will occur during runtime as a result of matching filenames. This parameter is active only if the Get document by parameter is set to Create. |
Row Column Properties
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
Clear content(s) |
--- |
--- |
--- |
--- |
If enabled, specifies that one or more rows/columns will be cleared of its contents. If this parameter is enabled, the Delete parameter is ignored. This is a design-time parameter, therefore, contains no markups. |
Delete |
Text |
Yes |
(Empty) |
CONTENTTYPE="Delete" |
If enabled, specifies that one or more cell rows/columns will be deleted. If this parameter is enabled, the Clear content(s) parameter is ignored. |
Delete |
Text (options) |
No |
Row |
ROWCOLUMNTYPE="Column" |
Specifies how the group of cells or cell contents to delete are ordered. The available options are:
|
Start index or column |
Number |
Yes |
(Empty) |
INDEX="A1" |
If deleting rows, specifies the index of the row from where the rows will be deleted (e.g., 1= the first row from the top, 2 = the second row from the top, etc.). If deleting columns, specifies the index of the column from where the columns will be deleted (e.g., 1= the first column from the left, 2 = the second column from the left, etc.). This parameter works in tandem with the Total count parameter. For example, if you want to delete the first 10 rows of the spreadsheet, set this parameter to 1 and the Total count parameter to 10. |
Total count |
Number |
Yes |
(Empty) |
TOTALCOUNT="10" |
If deleting rows, specifies the total number of rows that need to be deleted. If deleting columns, specifies the total number of columns that need to be deleted. For example if you want to delete the first 10 columns of the spreadsheet, set the Start index or column parameter to 1 and set this parameter to 10. |
Use active worksheet |
--- |
--- |
--- |
--- |
If enabled, specifies that this activity will be performed on the currently active worksheet. If this parameter is enabled, the Use specific worksheet parameter is ignored. This is a design-time parameter, therefore, contains no markups. |
Use specific worksheet |
Text |
No |
Save |
WORKSHEET="Sheet1" |
If enabled, specifies the path and filename of an existing worksheet in which this activity will be performed. If this parameter is enabled, the Use active worksheet parameter is ignored. |
Description tab - A custom description can be provided on the Description tab to convey additional information or share special notes about a task step.
Error Causes tab - Specify how this step should behave upon the occurrence of an error. (Refer to Task Builder > Error Causes Tab for details.)
On Error tab - Specify what AWE should do if this step encounters an error as defined on the Error Causes tab. (Refer to Task Builder > On Error Tab for details.)
Example
The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.
Description: Clear contents of "20" row(s) at index "10". Excel file "C:\temp\Employees.xls".
<AMODS ACTIVITY="delete_row_column" WORKBOOK="C:\temp\Employees.xls" OPENPASSWORD="AM4Q93+e+Rh0uwOq9NADylx5IO6XPwRknRkaME" SAVETYPE="save_as" DESTINATION="C:\temp3\newFile.xls" OVERWRITEDESTINATION="YES" INDEX="10" TOTALCOUNT="20" />