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 | excelRemoveSheet(workbookFID, worksheet_name) | Package | excel | Alias | | Pkg Usage | removeSheet(workbookFID, worksheet_name) | |
Description
Excerpt |
---|
|
Removes the selected sheet from an open workbook. |
Removes the selected sheet from an open 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 | Yes | The name of the worksheet to be deleted | |
Return Type
Boolean
Returns true if the operation was successful, false otherwise.
Example
Opens a workbook, deletes a sheet and then saves and closes the workbook.
Code Block |
---|
|
use "excel";
int fid = openWorkbook("snakes.xlsx");
removeSheet(fid, "Venemous Snakes", 4);
closeWorkbook(fid); |
Result: The 'Venemous Snakes' sheet will be removed.
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 |
---|
|