Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table plus
applyColStyleToCelltrue
heading0
columnTypess,s,s,s
multiplefalse
columnAttributesstyle="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold,
enableSortingfalse

Syntax

excelAddSheet(workbookFID, worksheet_name [, make_default])

Package

excel

Alias

Pkg Usage

addSheet(workbookFID, worksheet_name [, make_default])

Description

Excerpt
hiddentrue
Adds a new sheet to the open workbook.

Adds a new sheet to the open workbook.

Parameters

Table plus
applyColStyleToCelltrue
columnTypess,s,s,s
heading0
multiplefalse
enableSortingfalse

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.

Code Block
languagejs
use "excel";
int fid = openWorkbook("snakes.xlsx");
addSheet(fid, "Venemous Snakes", true);
closeWorkbook(fid);

Note

Click here to download the workbook used in this example.

See also

Filter by label (Content by label)
showLabelsfalse
max25
showSpacefalse
cqllabel = "excel_routine" and space = currentSpace ( )
labelsarray_routines