Table plus |
---|
applyColStyleToCell | true |
---|
heading | 0 |
---|
columnTypes | s,s,s,s |
---|
multiple | false |
---|
columnAttributes | style="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold, |
---|
enableSorting | false |
---|
|
Syntax | excelRemoveRow(workbookFID, [worksheet_name,] rowIndex) | Package | excel | Alias | | Pkg Usage | removeRow(workbookFID, [worksheet_name,] rowIndex) | |
Description
Excerpt |
---|
|
Removes a row in the opened workbook. |
Removes a row in the opened workbook.
Parameters
Table plus |
---|
applyColStyleToCell | true |
---|
columnTypes | s,s,s,s |
---|
heading | 0 |
---|
multiple | false |
---|
enableSorting | false |
---|
|
Parameter name | Type | Required | Description |
---|
workbookFID | Integer | Yes | The file id of the open workbook. The file id is returned from running the excelOpenWorkbook() routine. | worksheet_name | String | No | The name of the worksheet the row is on. | rowIndex | Integer | Yes | The row index of the row to be deleted (index starts at 0). | |
Return Type
Boolean
Returns true if the operation was successful, false otherwise.
Example
Opens a workbook, deletes a row and then saves and closes the workbook.
Code Block |
---|
|
use "excel";
int fid = openWorkbook("snakes.xlsx");
removeRow(fid, "Venemous Snakes", 4);
closeWorkbook(fid); |
Result: The row containg the Blue Krait snake (row 5) will be deleted.
Note |
---|
Click here to download the workbook used in this example. |
See also
Filter by label (Content by label) |
---|
showLabels | false |
---|
max | 25 |
---|
showSpace | false |
---|
cql | label = "excel_routine" and space = currentSpace ( ) |
---|
labels | array_routines |
---|
|