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

excelOpenWorkbook(path_to_excel_file)

Package

excel

Alias

Pkg Usage

openWorkbook(path_to_excel_file)

Description

Excerpt
hiddentrue
Opens a workbook so that it may be used in the script.

Opens a workbook so that it may be used in the script.

Parameters

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

Parameter name

Type

Required

Description

path_to_excel_file

String

Yes

File path of the workbook to open.

Return Type

Integer

Example

Opens a workbook, adds a new worksheet and then saves and closes the 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