Adds the External Link Table part and relations required to allow formulas referencing the specified external workbook to be added to this one. Allows formulas such as "[MyOtherWorkbook.xlsx]Sheet3!$A$5" to be added to the file, for workbooks not already linked / referenced. Note: this is not implemented and thus currently throws an Exception stating this.

Validate sheet index

Specifies a boolean value that indicates whether structure of workbook is locked.
A value true indicates the structure of the workbook is locked. Worksheets in the workbook can't be moved, deleted, hidden, unhidden, or renamed, and new worksheets can't be inserted.
A value of false indicates the structure of the workbook is not locked.

Specifies a boolean value that indicates whether the windows that comprise the workbook are locked.
A value of true indicates the workbook windows are locked. Windows are the same size and position each time the workbook is opened.
A value of false indicates the workbook windows are not locked.

Specifies a boolean value that indicates whether the workbook is locked for revisions.

Locks the structure of workbook.

Whether Excel will be asked to recalculate all formulas when the workbook is opened.

Unlocks the structure of workbook.

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.

Locks the windows that comprise the workbook.

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.

Are we a normal workbook (.xlsx), or a macro enabled workbook (.xlsm)?

Gets the first tab that is displayed in the list of tabs in excel.

Sets the first tab that is displayed in the list of tabs in excel.

Adds a vbaProject.bin file taken from another, given workbook to this one.

Unlocks the workbook for revisions.

sets the order of appearance for a given sheet.

We only set one sheet as selected for compatibility with HSSF.

Set the sheet name.

Validate the password against the stored hash, the hashing method will be determined by the existing password attributes

Generate a valid sheet name based on the existing one. Used when cloning sheets.

Sets the revisions password.

Unlocks the windows that comprise the workbook.

Returns the index of the given sheet

Generates a NameRecord to represent a built-in region

Create an XSSFSheet for this workbook, adds it to the sheets and returns the high level representation. Use this to create new sheets.

Locks the workbook for revisions.

Create a new sheet for this Workbook and return the high level representation. Use this to create new sheets.

Note that Excel allows sheet names up to 31 chars in length but other applications (such as OpenOffice) allow more. Some versions of Excel crash with names longer than 31 chars, others - truncate such names to 31 character.

POI's SpreadsheetAPI silently truncates the input argument to 31 characters. Example:

     Sheet sheet = workbook.createSheet("My very long sheet name which is longer than 31 chars"); // will be truncated
     assert 31 == sheet.getSheetName().length();
     assert "My very long sheet name which i" == sheet.getSheetName();
     

Except the 31-character constraint, Excel applies some other rules:

Sheet name MUST be unique in the workbook and MUST NOT contain the any of the following characters:

• 0x0000
• 0x0003
• colon (:)
• backslash (\)
• asterisk (*)
• question mark (?)
• forward slash (/)
• opening square bracket ([)
• closing square bracket (])

The string MUST NOT begin or end with the single quote (') character.

See {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)} for a safe way to create valid names

Get the number of worksheets in the this workbook

Sets the workbook password.

Alias for {@link #sheetIterator()} to allow foreach loops Note: remove() is not supported on this iterator. Use {@link #removeSheetAt(int)} to remove sheets instead.

Get the sheet name

Get the XSSFSheet object at the given index.

Get sheet with the given name (case insensitive match)

Removes sheet at the given index.

Care must be taken if the removed sheet is the currently active or only selected sheet in the workbook. There are a few situations when Excel must have a selection and/or active sheet. (For example when printing - see Bug 40414).
This method makes sure that if the removed sheet was active, another sheet will become active in its place. Furthermore, if the removed sheet was the only selected sheet, another sheet will become selected. The newly active/selected sheet will have the same index, or one less if the removed sheet was the last in the workbook.

update sheet-scoped named ranges in this workbook after changing the sheet order of a sheet at oldIndex to newIndex. Sheets between these indices will move left or right by 1.

Sets whether the workbook will be an .xlsx or .xlsm (macro-enabled) file.

Create a new Font and add it to the workbook's font table

Adds a vbaProject.bin file to the workbook. This will change the workbook type if necessary.

Finds a font that matches the one with the supplied attributes

Get the number of fonts in the this workbook

marshal named ranges from the {@link #namedRanges} collection to the underlying CTWorkbook bean

Create a new XSSFCellStyle and add it to the workbook's style table

Get the number of styles the workbook contains

Get the cell style object at the given index

Returns the locator of user-defined functions.

The default instance extends the built-in functions with the Excel Analysis Tool Pack. To set / evaluate custom functions you need to register them as follows:

Returns the index of the sheet by his name (case insensitive match)

Returns the spreadsheet version (EXCLE2007) of this workbook

Returns the data table with the given name (case insensitive).

Get the number of named ranges in the this workbook

Get the named range at the given index.

Get the first named range with the given name. Note: names of named ranges are not unique as they are scoped by sheet. {@link #getNames(String name)} returns all named ranges with the given name.

Get the named ranges with the given name. Note:Excel named ranges are case-insensitive and this method performs a case-insensitive search.

Get a list of all the named ranges in the workbook.

Return a object representing a collection of shared objects used for styling content, e.g. fonts, cell styles, colors, etc.

Returns the Theme of current workbook.

Not normally to be called externally, but possibly to be overridden to avoid the DOM based parse of large sheets (see examples).

Returns an object that handles instantiating concrete classes of the various instances for XSSF.

Gets the named range index by name.

Remove the named range at the given index.

Remove the first named range found with the given name. Note: names of named ranges are not unique (name + sheet index is unique), so {@link #removeName(Name)} should be used if possible.

Create a new CTWorkbook with all values set to default

As {@link #removeName(String)} is not necessarily unique (name + sheet index is unique), this method is more accurate.

Sets the printarea for the sheet provided

i.e. Reference = $A$1:$B$2

Returns an iterator of the sheets in the workbook in sheet order. Includes hidden and very hidden sheets. Note: remove() is not supported on this iterator. Use {@link #removeSheetAt(int)} to remove sheets instead.

For the Convenience of Java Programmers maintaining pointers.

Get the document's embedded files.

Create a new SpreadsheetML package and setup the default minimal content

Delete the printarea for the sheet specified

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. {@link MissingCellPolicy}

Returns SharedStringsTable - tha cache of string for this workbook

Sets the policy on what to do when getting missing or blank cells from a row. This will then apply to all calls to {@link Row#getCell(int)}}. See {@link MissingCellPolicy}

Returns the workbook's data format table (a factory for creating data format strings).

Return the underlying XML bean

Adds a picture to the workbook.

Gets all pictures from the Workbook.

Retrieves the reference for the printarea of the specified sheet, the sheet name is appended to the reference even if it was not specified.

Determines whether a workbook contains the provided sheet name. For the purpose of comparison, long names are truncated to 31 chars.

Gets a boolean value that indicates whether the date systems used in the workbook starts in 1904.

The default value is false, meaning that the workbook uses the 1900 date system, where 1/1/1900 is the first day in the system..

Removes the workbook protection settings

Adds a picture to the workbook.

Gracefully remove references to the sheet being deleted

Create an XSSFSheet from an existing sheet in the XSSFWorkbook. The cloned sheet is a deep copy of the original.

Create an XSSFSheet from an existing sheet in the XSSFWorkbook. The cloned sheet is a deep copy of the original but with a new given name.

Add pivotCache to the workbook

Get the font at the given index number

Fired when a formula is deleted from this workbook, for example when calling cell.setCellFormula(null)

Validate the password against the stored hash, the hashing method will be determined by the existing password attributes

Register a new toolpack in this workbook.

Return the {@link CalculationChain} object for this workbook

The calculation chain object specifies the order in which the cells in a workbook were last calculated

Returns the list of {@link ExternalLinksTable} object for this workbook

The external links table specifies details of named ranges etc that are referenced from other workbooks, along with the last seen values of what they point to.

Note that Excel uses index 0 for the current workbook, so the first External Links in a formula would be '[1]Foo' which corresponds to entry 0 in this list.

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 true, this flag will tell Excel that it needs to recalculate all formulas in the workbook the next time the file is opened.

Note, that recalculation updates cached formula results and, thus, modifies the workbook. Depending on the version, Excel may prompt you with "Do you want to save the changes in filename?" on close.