excelAddSheet
Syntax | excelAddSheet(workbookFID, worksheet_name [, make_default]) | Package | excel |
Alias |
| Pkg Usage | addSheet(workbookFID, worksheet_name [, make_default]) |
Description
Adds a new sheet to the open workbook.
Parameters
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 added. |
make_default | Boolean | No | If the newley added worksheet should be made the default worksheet, true/false. |
Return Type
Boolean
Returns true if the operation was successful, false otherwise.
Example
Add a new worksheet to an existing workbook.
use "excel";
int fid = openWorkbook("snakes.xlsx");
addSheet(fid, "Venemous Snakes", true);
closeWorkbook(fid);Click here to download the workbook used in this example.
See also
Need support? Create a request with our support team.
Copyright © 2005 - 2025 Appfire | All rights reserved.