Class SXSSFWorkbook
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Iterable<Sheet>
,Workbook
- Direct Known Subclasses:
SXSSFWorkbookWithCustomZipEntrySource
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Specifies how many rows can be accessed at most viaSXSSFSheet.getRow(int)
.Fields inherited from interface org.apache.poi.ss.usermodel.Workbook
PICTURE_TYPE_DIB, PICTURE_TYPE_EMF, PICTURE_TYPE_JPEG, PICTURE_TYPE_PICT, PICTURE_TYPE_PNG, PICTURE_TYPE_WMF
-
Constructor Summary
ConstructorsConstructorDescriptionConstruct a new workbook with default row window sizeSXSSFWorkbook
(int rowAccessWindowSize) Construct an empty workbook and specify the window for row access.SXSSFWorkbook
(XSSFWorkbook workbook) Construct a workbook from a template.SXSSFWorkbook
(XSSFWorkbook workbook, int rowAccessWindowSize) Constructs an workbook from an existing workbook.SXSSFWorkbook
(XSSFWorkbook workbook, int rowAccessWindowSize, boolean compressTmpFiles) Constructs an workbook from an existing workbook.SXSSFWorkbook
(XSSFWorkbook workbook, int rowAccessWindowSize, boolean compressTmpFiles, boolean useSharedStringsTable) Constructs an workbook from an existing workbook. -
Method Summary
Modifier and TypeMethodDescriptionint
addOlePackage
(byte[] oleData, String label, String fileName, String command) Adds an OLE package manager object with the given content to the sheetint
addPicture
(byte[] pictureData, int format) Adds a picture to the workbook.void
addToolPack
(UDFFinder toopack) Register a new toolpack in this workbook.cloneSheet
(int sheetNum) Not implemented for SXSSFWorkbook Create an Sheet from an existing sheet in the Workbook.void
close()
Closes the underlyingXSSFWorkbook
andOPCPackage
on which this Workbook is based, if any.Create a new Cell style and add it to the workbook's style tableReturns the instance of DataFormat for this workbook.Create a new Font and add it to the workbook's font tableCreates a new (uninitialised) defined name in this workbookSreate an Sheet for this Workbook, adds it to the sheets and returns the high level representation.createSheet
(String sheetname) Create an Sheet for this Workbook, adds it to the sheets and returns the high level representation.protected SheetDataWriter
boolean
dispose()
Dispose of temporary files backing this workbook on disk.findFont
(boolean bold, short color, short fontHeight, String name, boolean italic, boolean strikeout, short typeOffset, byte underline) Finds a font that matches the one with the supplied attributesprotected void
int
Convenience method to get the active sheet.Returns all defined namesList<? extends PictureData>
Gets all pictures from the Workbook.getCellStyleAt
(int idx) Get the cell style object at the given indexReturns an object that handles instantiating concrete classes of the various instances one needs for HSSF, XSSF and SXSSF.int
Gets the first tab that is displayed in the list of tabs in excel.getFontAt
(int idx) Get the font at the given index numbergetFontAt
(short idx) Deprecated.boolean
Whether Excel will be asked to recalculate all formulas when the workbook is opened.Retrieves the current policy on what to do when getting missing or blank cells from a row.getNameAt
(int nameIndex) Deprecated.3.16.int
getNameIndex
(String name) Deprecated.3.16.Returns all defined names with the given name.short
Deprecated.int
Get the number of fonts in the font tableint
int
Get the number of spreadsheets in the workbookint
Get the number of styles the workbook containsgetPrintArea
(int sheetIndex) Retrieves the reference for the printarea of the specified sheet, the sheet name is appended to the reference even if it was not specified.int
See the constructors for a more detailed description of the sliding window of rows.protected SharedStringsTable
Get sheet with the given namegetSheetAt
(int index) Get the Sheet object at the given index.int
getSheetIndex
(String name) Returns the index of the sheet by his nameint
getSheetIndex
(Sheet sheet) Returns the index of the given sheetgetSheetName
(int sheet) Set the sheet namegetSheetVisibility
(int sheetIx) Get the visibility (visible, hidden, very hidden) of a sheet in this workbookReturns the spreadsheet version (EXCLE2007) of this workbookprotected void
injectData
(ZipEntrySource zipEntrySource, OutputStream out) boolean
Get whether temp files should be compressed.protected boolean
boolean
isHidden()
boolean
isSheetHidden
(int sheetIx) Check whether a sheet is hidden.boolean
isSheetVeryHidden
(int sheetIx) Check whether a sheet is very hidden.iterator()
Alias forsheetIterator()
to allow foreach loopsint
linkExternalWorkbook
(String name, Workbook workbook) Not implemented for SXSSFWorkbook Adds the LinkTable records required to allow formulas referencing the specified external workbook to be added to this one.void
removeName
(int index) Deprecated.3.16.void
removeName
(String name) Deprecated.3.16.void
removeName
(Name name) Remove the given defined namevoid
removePrintArea
(int sheetIndex) Delete the printarea for the sheet specifiedvoid
removeSheetAt
(int index) Removes sheet at the given indexvoid
setActiveSheet
(int sheetIndex) Convenience method to set the active sheet.void
setCompressTempFiles
(boolean compress) Set whether temp files should be compressed.void
setFirstVisibleTab
(int sheetIndex) Sets the first tab that is displayed in the list of tabs in excel.void
setForceFormulaRecalculation
(boolean value) Whether the application shall perform a full recalculation when the workbook is opened.void
setHidden
(boolean hiddenFlag) void
setMissingCellPolicy
(Row.MissingCellPolicy missingCellPolicy) Sets the policy on what to do when getting missing or blank cells from a row.void
setPrintArea
(int sheetIndex, int startColumn, int endColumn, int startRow, int endRow) For the Convenience of Java Programmers maintaining pointers.void
setPrintArea
(int sheetIndex, String reference) Sets the printarea for the sheet providedvoid
setSelectedTab
(int index) Sets the tab whose data is actually seen when the sheet is opened.void
setSheetHidden
(int sheetIx, boolean hidden) Hide or unhide a sheet.void
setSheetName
(int sheet, String name) Set the sheet name.void
setSheetOrder
(String sheetname, int pos) Sets the order of appearance for a given sheet.void
setSheetVisibility
(int sheetIx, SheetVisibility visibility) Hide or unhide a sheet.Returns an iterator of the sheets in the workbook in sheet order.void
write
(OutputStream stream) Write out this workbook to an OutputStream.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Field Details
-
DEFAULT_WINDOW_SIZE
public static final int DEFAULT_WINDOW_SIZESpecifies how many rows can be accessed at most viaSXSSFSheet.getRow(int)
. When a new node is created viaSXSSFSheet.createRow(int)
and the total number of unflushed records would exceed the specified value, then the row with the lowest index value is flushed and cannot be accessed viaSXSSFSheet.getRow(int)
anymore.- See Also:
-
-
Constructor Details
-
SXSSFWorkbook
public SXSSFWorkbook()Construct a new workbook with default row window size -
SXSSFWorkbook
Construct a workbook from a template.
There are three use-cases to use SXSSFWorkbook(XSSFWorkbook) :- Append new sheets to existing workbooks. You can open existing workbook from a file or create on the fly with XSSF.
-
Append rows to existing sheets. The row number MUST be greater
than
max(rownum)
in the template sheet. - Use existing workbook as a template and re-use global objects such as cell styles, formats, images, etc.
-
Access initial cells and rows in the template. After constructing
all internal windows are empty and
SXSSFSheet.getRow(int)
andSXSSFRow.getCell(int)
returnnull
. - Override existing cells and rows. The API silently allows that but the output file is invalid and Excel cannot read it.
- Parameters:
workbook
- the template workbook
-
SXSSFWorkbook
Constructs an workbook from an existing workbook.When a new node is created via
SXSSFSheet.createRow(int)
and the total number of unflushed records would exceed the specified value, then the row with the lowest index value is flushed and cannot be accessed viaSXSSFSheet.getRow(int)
anymore.A value of
-1
indicates unlimited access. In this case all records that have not been flushed by a call toflush()
are available for random access.A value of
0
is not allowed because it would flush any newly created row without having a chance to specify any cells.- Parameters:
rowAccessWindowSize
- the number of rows that are kept in memory until flushed out, see above.
-
SXSSFWorkbook
Constructs an workbook from an existing workbook.When a new node is created via
SXSSFSheet.createRow(int)
and the total number of unflushed records would exceed the specified value, then the row with the lowest index value is flushed and cannot be accessed viaSXSSFSheet.getRow(int)
anymore.A value of
-1
indicates unlimited access. In this case all records that have not been flushed by a call toflush()
are available for random access.A value of
0
is not allowed because it would flush any newly created row without having a chance to specify any cells.- Parameters:
rowAccessWindowSize
- the number of rows that are kept in memory until flushed out, see above.compressTmpFiles
- whether to use gzip compression for temporary files
-
SXSSFWorkbook
public SXSSFWorkbook(XSSFWorkbook workbook, int rowAccessWindowSize, boolean compressTmpFiles, boolean useSharedStringsTable) Constructs an workbook from an existing workbook.When a new node is created via
SXSSFSheet.createRow(int)
and the total number of unflushed records would exceed the specified value, then the row with the lowest index value is flushed and cannot be accessed viaSXSSFSheet.getRow(int)
anymore.A value of
-1
indicates unlimited access. In this case all records that have not been flushed by a call toflush()
are available for random access.A value of
0
is not allowed because it would flush any newly created row without having a chance to specify any cells.- Parameters:
workbook
- the template workbookrowAccessWindowSize
- the number of rows that are kept in memory until flushed out, see above.compressTmpFiles
- whether to use gzip compression for temporary filesuseSharedStringsTable
- whether to use a shared strings table
-
SXSSFWorkbook
public SXSSFWorkbook(int rowAccessWindowSize) Construct an empty workbook and specify the window for row access.When a new node is created via
SXSSFSheet.createRow(int)
and the total number of unflushed records would exceed the specified value, then the row with the lowest index value is flushed and cannot be accessed viaSXSSFSheet.getRow(int)
anymore.A value of
-1
indicates unlimited access. In this case all records that have not been flushed by a call toflush()
are available for random access.A value of
0
is not allowed because it would flush any newly created row without having a chance to specify any cells.- Parameters:
rowAccessWindowSize
- the number of rows that are kept in memory until flushed out, see above.
-
-
Method Details
-
getRandomAccessWindowSize
public int getRandomAccessWindowSize()See the constructors for a more detailed description of the sliding window of rows.- Returns:
- The number of rows that are kept in memory at once before flushing them out.
-
isCompressTempFiles
public boolean isCompressTempFiles()Get whether temp files should be compressed.- Returns:
- whether to compress temp files
-
setCompressTempFiles
public void setCompressTempFiles(boolean compress) Set whether temp files should be compressed.SXSSF writes sheet data in temporary files (a temp file per-sheet) and the size of these temp files can grow to to a very large size, e.g. for a 20 MB csv data the size of the temp xml file become few GB large. If the "compress" flag is set to
true
then the temporary XML is gzipped.Please note the the "compress" option may cause performance penalty.
Setting this option only affects compression for subsequent
createSheet()
calls.- Parameters:
compress
- whether to compress temp files
-
createSheetDataWriter
- Throws:
IOException
-
injectData
- Throws:
IOException
-
getXSSFWorkbook
-
getActiveSheetIndex
public int getActiveSheetIndex()Convenience method to get the active sheet. The active sheet is is the sheet which is currently displayed when the workbook is viewed in Excel. 'Selected' sheet(s) is a distinct concept.- Specified by:
getActiveSheetIndex
in interfaceWorkbook
- Returns:
- the index of the active sheet (0-based)
-
setActiveSheet
public void setActiveSheet(int sheetIndex) Convenience method to set the active sheet. The active sheet is is the sheet which is currently displayed when the workbook is viewed in Excel. 'Selected' sheet(s) is a distinct concept.- Specified by:
setActiveSheet
in interfaceWorkbook
- Parameters:
sheetIndex
- index of the active sheet (0-based)
-
getFirstVisibleTab
public int getFirstVisibleTab()Gets the first tab that is displayed in the list of tabs in excel.- Specified by:
getFirstVisibleTab
in interfaceWorkbook
- Returns:
- the first tab that to display in the list of tabs (0-based).
-
setFirstVisibleTab
public void setFirstVisibleTab(int sheetIndex) Sets the first tab that is displayed in the list of tabs in excel.- Specified by:
setFirstVisibleTab
in interfaceWorkbook
- Parameters:
sheetIndex
- the first tab that to display in the list of tabs (0-based)
-
setSheetOrder
Sets the order of appearance for a given sheet.- Specified by:
setSheetOrder
in interfaceWorkbook
- Parameters:
sheetname
- the name of the sheet to reorderpos
- the position that we want to insert the sheet into (0 based)
-
setSelectedTab
public void setSelectedTab(int index) Sets the tab whose data is actually seen when the sheet is opened. This may be different from the "selected sheet" since excel seems to allow you to show the data of one sheet when another is seen "selected" in the tabs (at the bottom).- Specified by:
setSelectedTab
in interfaceWorkbook
- Parameters:
index
- the index of the sheet to select (0 based)- See Also:
-
setSheetName
Set the sheet name.- Specified by:
setSheetName
in interfaceWorkbook
- Parameters:
sheet
- number (0 based)- Throws:
IllegalArgumentException
- if the name is greater than 31 chars or contains/\?*[]
- See Also:
-
getSheetName
Set the sheet name- Specified by:
getSheetName
in interfaceWorkbook
- Parameters:
sheet
- sheet number (0 based)- Returns:
- Sheet name
-
getSheetIndex
Returns the index of the sheet by his name- Specified by:
getSheetIndex
in interfaceWorkbook
- Parameters:
name
- the sheet name- Returns:
- index of the sheet (0 based)
-
getSheetIndex
Returns the index of the given sheet- Specified by:
getSheetIndex
in interfaceWorkbook
- Parameters:
sheet
- the sheet to look up- Returns:
- index of the sheet (0 based)
-
createSheet
Sreate an Sheet for this Workbook, adds it to the sheets and returns the high level representation. Use this to create new sheets.- Specified by:
createSheet
in interfaceWorkbook
- Returns:
- Sheet representing the new sheet.
-
createSheet
Create an Sheet for this Workbook, adds it to the sheets and returns the high level representation. Use this to create new sheets.- Specified by:
createSheet
in interfaceWorkbook
- Parameters:
sheetname
- sheetname to set for the sheet.- Returns:
- Sheet representing the new sheet.
- Throws:
IllegalArgumentException
- if the name is greater than 31 chars or contains/\?*[]
- See Also:
-
cloneSheet
Not implemented for SXSSFWorkbook Create an Sheet from an existing sheet in the Workbook.- Specified by:
cloneSheet
in interfaceWorkbook
- Returns:
- Sheet representing the cloned sheet.
-
getNumberOfSheets
public int getNumberOfSheets()Get the number of spreadsheets in the workbook- Specified by:
getNumberOfSheets
in interfaceWorkbook
- Returns:
- the number of sheets
-
sheetIterator
Returns an iterator of the sheets in the workbook in sheet order. Includes hidden and very hidden sheets.- Specified by:
sheetIterator
in interfaceWorkbook
- Returns:
- an iterator of the sheets.
-
iterator
Alias forsheetIterator()
to allow foreach loops -
getSheetAt
Get the Sheet object at the given index.- Specified by:
getSheetAt
in interfaceWorkbook
- Parameters:
index
- of the sheet number (0-based physical and logical)- Returns:
- Sheet at the provided index
-
getSheet
Get sheet with the given name -
removeSheetAt
public void removeSheetAt(int index) Removes sheet at the given index- Specified by:
removeSheetAt
in interfaceWorkbook
- Parameters:
index
- of the sheet to remove (0-based)
-
createFont
Create a new Font and add it to the workbook's font table- Specified by:
createFont
in interfaceWorkbook
- Returns:
- new font object
-
findFont
public Font findFont(boolean bold, short color, short fontHeight, String name, boolean italic, boolean strikeout, short typeOffset, byte underline) Finds a font that matches the one with the supplied attributes -
getNumberOfFonts
Deprecated.Description copied from interface:Workbook
Get the number of fonts in the font table- Specified by:
getNumberOfFonts
in interfaceWorkbook
- Returns:
- number of fonts
-
getNumberOfFontsAsInt
public int getNumberOfFontsAsInt()Description copied from interface:Workbook
Get the number of fonts in the font table- Specified by:
getNumberOfFontsAsInt
in interfaceWorkbook
- Returns:
- number of fonts
-
getFontAt
Deprecated.Description copied from interface:Workbook
Get the font at the given index number -
getFontAt
Description copied from interface:Workbook
Get the font at the given index number -
createCellStyle
Create a new Cell style and add it to the workbook's style table- Specified by:
createCellStyle
in interfaceWorkbook
- Returns:
- the new Cell Style object
-
getNumCellStyles
public int getNumCellStyles()Get the number of styles the workbook contains- Specified by:
getNumCellStyles
in interfaceWorkbook
- Returns:
- count of cell styles
-
getCellStyleAt
Get the cell style object at the given index- Specified by:
getCellStyleAt
in interfaceWorkbook
- Parameters:
idx
- index within the set of styles (0-based)- Returns:
- CellStyle object at the index
-
close
Closes the underlyingXSSFWorkbook
andOPCPackage
on which this Workbook is based, if any.Once this has been called, no further operations, updates or reads should be performed on the Workbook.
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in interfaceWorkbook
- Throws:
IOException
-
write
Write out this workbook to an OutputStream.- Specified by:
write
in interfaceWorkbook
- Parameters:
stream
- - the java OutputStream you wish to write to- Throws:
IOException
- if anything can't be written.
-
flushSheets
- Throws:
IOException
-
dispose
public boolean dispose()Dispose of temporary files backing this workbook on disk. Calling this method will render the workbook unusable.- Returns:
- true if all temporary files were deleted successfully.
-
getNumberOfNames
public int getNumberOfNames()- Specified by:
getNumberOfNames
in interfaceWorkbook
- Returns:
- the total number of defined names in this workbook
-
getName
-
getNames
Returns all defined names with the given name. -
getAllNames
Returns all defined names- Specified by:
getAllNames
in interfaceWorkbook
- Returns:
- all defined names
-
createName
Creates a new (uninitialised) defined name in this workbook- Specified by:
createName
in interfaceWorkbook
- Returns:
- new defined name object
-
removeName
Remove the given defined name- Specified by:
removeName
in interfaceWorkbook
- Parameters:
name
- the name to remove
-
setPrintArea
Sets the printarea for the sheet providedi.e. Reference = $A$1:$B$2
- Specified by:
setPrintArea
in interfaceWorkbook
- Parameters:
sheetIndex
- Zero-based sheet index (0 Represents the first sheet to keep consistent with java)reference
- Valid name Reference for the Print Area
-
setPrintArea
public void setPrintArea(int sheetIndex, int startColumn, int endColumn, int startRow, int endRow) For the Convenience of Java Programmers maintaining pointers.- Specified by:
setPrintArea
in interfaceWorkbook
- Parameters:
sheetIndex
- Zero-based sheet index (0 = First Sheet)startColumn
- Column to begin printareaendColumn
- Column to end the printareastartRow
- Row to begin the printareaendRow
- Row to end the printarea- See Also:
-
getPrintArea
Retrieves the reference for the printarea of the specified sheet, the sheet name is appended to the reference even if it was not specified.- Specified by:
getPrintArea
in interfaceWorkbook
- Parameters:
sheetIndex
- Zero-based sheet index (0 Represents the first sheet to keep consistent with java)- Returns:
- String Null if no print area has been defined
-
removePrintArea
public void removePrintArea(int sheetIndex) Delete the printarea for the sheet specified- Specified by:
removePrintArea
in interfaceWorkbook
- Parameters:
sheetIndex
- Zero-based sheet index (0 = First Sheet)
-
getMissingCellPolicy
Retrieves the current policy on what to do when getting missing or blank cells from a row.The default is to return blank and null cells.
Row.MissingCellPolicy
- Specified by:
getMissingCellPolicy
in interfaceWorkbook
-
setMissingCellPolicy
Sets the policy on what to do when getting missing or blank cells from a row. This will then apply to all calls toRow.getCell(int)
. SeeRow.MissingCellPolicy
- Specified by:
setMissingCellPolicy
in interfaceWorkbook
-
createDataFormat
Returns the instance of DataFormat for this workbook.- Specified by:
createDataFormat
in interfaceWorkbook
- Returns:
- the DataFormat object
-
addPicture
public int addPicture(byte[] pictureData, int format) Adds a picture to the workbook.- Specified by:
addPicture
in interfaceWorkbook
- Parameters:
pictureData
- The bytes of the pictureformat
- The format of the picture.- Returns:
- the index to this picture (1 based).
- See Also:
-
getAllPictures
Gets all pictures from the Workbook.- Specified by:
getAllPictures
in interfaceWorkbook
- Returns:
- the list of pictures (a list of
PictureData
objects.)
-
getCreationHelper
Returns an object that handles instantiating concrete classes of the various instances one needs for HSSF, XSSF and SXSSF.- Specified by:
getCreationHelper
in interfaceWorkbook
-
isDate1904
protected boolean isDate1904() -
isHidden
-
setHidden
@NotImplemented("XSSFWorkbook#setHidden is not implemented") public void setHidden(boolean hiddenFlag) -
isSheetHidden
public boolean isSheetHidden(int sheetIx) Description copied from interface:Workbook
Check whether a sheet is hidden.Note that a sheet could instead be set to be very hidden, which is different (
Workbook.isSheetVeryHidden(int)
)- Specified by:
isSheetHidden
in interfaceWorkbook
- Parameters:
sheetIx
- Number- Returns:
true
if sheet is hidden- See Also:
-
isSheetVeryHidden
public boolean isSheetVeryHidden(int sheetIx) Description copied from interface:Workbook
Check whether a sheet is very hidden.This is different from the normal hidden status (
Workbook.isSheetHidden(int)
)- Specified by:
isSheetVeryHidden
in interfaceWorkbook
- Parameters:
sheetIx
- sheet index to check- Returns:
true
if sheet is very hidden- See Also:
-
getSheetVisibility
Description copied from interface:Workbook
Get the visibility (visible, hidden, very hidden) of a sheet in this workbook- Specified by:
getSheetVisibility
in interfaceWorkbook
- Parameters:
sheetIx
- the index of the sheet- Returns:
- the sheet visibility
-
setSheetHidden
public void setSheetHidden(int sheetIx, boolean hidden) Description copied from interface:Workbook
Hide or unhide a sheet. Please note that the sheet currently set as active sheet (sheet 0 in a newly created workbook or the one set via setActiveSheet()) cannot be hidden.- Specified by:
setSheetHidden
in interfaceWorkbook
- Parameters:
sheetIx
- the sheet index (0-based)hidden
- True to mark the sheet as hidden, false otherwise- See Also:
-
setSheetVisibility
Description copied from interface:Workbook
Hide or unhide a sheet. Please note that the sheet currently set as active sheet (sheet 0 in a newly created workbook or the one set via setActiveSheet()) cannot be hidden.- Specified by:
setSheetVisibility
in interfaceWorkbook
- Parameters:
sheetIx
- the sheet index (0-based)visibility
- the sheet visibility to set
-
getNameAt
Deprecated.3.16. New projects should avoid accessing named ranges by index.- Specified by:
getNameAt
in interfaceWorkbook
- Parameters:
nameIndex
- position of the named range (0-based)- Returns:
- the defined name at the specified index
- Throws:
IllegalArgumentException
- if the supplied index is invalid
-
getNameIndex
Deprecated.3.16. New projects should avoid accessing named ranges by index. UsegetName(String)
instead.Gets the defined name index by name Note: Excel defined names are case-insensitive and this method performs a case-insensitive search.- Specified by:
getNameIndex
in interfaceWorkbook
- Parameters:
name
- the name of the defined name- Returns:
- zero based index of the defined name.
-1
if not found.
-
removeName
Deprecated.3.16. New projects should useremoveName(Name)
.Remove the defined name at the specified index- Specified by:
removeName
in interfaceWorkbook
- Parameters:
index
- named range index (0 based)
-
removeName
Deprecated.3.16. New projects should useremoveName(Name)
.Remove a defined name by name- Specified by:
removeName
in interfaceWorkbook
- Parameters:
name
- the name of the defined name
-
linkExternalWorkbook
Not implemented for SXSSFWorkbook Adds the LinkTable records required to allow formulas referencing the specified external workbook to be added to this one. Allows formulas such as "[MyOtherWorkbook]Sheet3!$A$5" to be added to the file, for workbooks not already referenced. Note: this is not implemented and thus currently throws an Exception stating this.- Specified by:
linkExternalWorkbook
in interfaceWorkbook
- Parameters:
name
- The name the workbook will be referenced as in formulasworkbook
- The open workbook to fetch the link required information from- Throws:
RuntimeException
- stating that this method is not implemented yet.
-
addToolPack
Register a new toolpack in this workbook.- Specified by:
addToolPack
in interfaceWorkbook
- Parameters:
toopack
- the toolpack to register
-
setForceFormulaRecalculation
public void setForceFormulaRecalculation(boolean value) Whether the application shall perform a full recalculation when the workbook is opened.Typically you want to force formula recalculation when you modify cell formulas or values of a workbook previously created by Excel. When set to 0, this flag will tell Excel that it needs to recalculate all formulas in the workbook the next time the file is opened.
- Specified by:
setForceFormulaRecalculation
in interfaceWorkbook
- Parameters:
value
- true if the application will perform a full recalculation of workbook values when the workbook is opened- Since:
- 3.8
-
getForceFormulaRecalculation
public boolean getForceFormulaRecalculation()Whether Excel will be asked to recalculate all formulas when the workbook is opened.- Specified by:
getForceFormulaRecalculation
in interfaceWorkbook
-
getSpreadsheetVersion
Returns the spreadsheet version (EXCLE2007) of this workbook- Specified by:
getSpreadsheetVersion
in interfaceWorkbook
- Returns:
- EXCEL2007 SpreadsheetVersion enum
- Since:
- 3.14 beta 2
-
addOlePackage
public int addOlePackage(byte[] oleData, String label, String fileName, String command) throws IOException Description copied from interface:Workbook
Adds an OLE package manager object with the given content to the sheet- Specified by:
addOlePackage
in interfaceWorkbook
- Parameters:
oleData
- the payloadlabel
- the label of the payloadfileName
- the original filenamecommand
- the command to open the payload- Returns:
- the index of the added ole object, i.e. the storage id
- Throws:
IOException
- if the object can't be embedded
-