Wiki source code of ExcelWritableWorkbook

Last modified by Maurice Gasco on 2018/06/07 16:46

Show last authors
1 The ExcelWritableWorkbook is returned by the ExcelWorkbook.loadWritable functions.
2 It should not be instantiated.
3
4 == Functions ==
5 === getWorkbookFile() ===
6 Write the Excel workbook as a binary. The binary can be used for file attachmments or Downloads.
7
8 example:
9 {{code language="javascript"}}
10 data = xls.getWorkbookFile(); // data is a file attachment
11 {{/code}}
12
13 @return: The binary
14 === getNumberOfSheets() ===
15 Get the number of sheets in the Workbook
16
17 @return: The number of sheets as an integer
18 === createSheet(sheetName, position) ===
19 Create a new Sheet in the Workbook
20 * sheetName
21 * position
22
23 @return: A Writable Sheet
24 === copySheet(sourceSheetName, targetSheetName, position) ===
25 Copy a sheet into another sheet
26 * sourceSheetName
27 * targetSheetName
28 * position
29
30 @return: A Writable Sheet
31 === getSheetByName(sheetName) ===
32 Get a Sheet in the Workbook by its name
33 * sheetName
34
35 @return: A Writable Sheet
36 === getSheetByPosition(position) ===
37 Get a sheet by position
38 * position
39
40 @return: A Writable Sheet
This wiki is licensed under a Creative Commons 2.0 license
XWiki Enterprise 9.11.5 - Documentation