WorkBookHandle (OpenXLS Java Spreadsheet SDK 11.0.4 API)

java.lang.Object
- io.starter.OpenXLS.DocumentHandle
- - io.starter.OpenXLS.WorkBookHandle

All Implemented Interfaces:

Document, Handle, WorkBook, Closeable, AutoCloseable
```
public class WorkBookHandle
extends DocumentHandle
implements WorkBook, Handle
```
The WorkBookHandle provides a handle to the XLS file and includes convenience methods for working with the WorkSheets and Cell values within the XLS file. For example:
WorkBookHandle book = new WorkBookHandle("testxls.xls"); WorkSheetHandle sheet = book.getWorkSheet("Sheet1"); CellHandle cell = sheet.getCell("B22");
By default, OpenXLS will lock open WorkBook files. To close the file after parsing and work with a temporary file instead, use the following setting:
System.getProperties().put(WorkBookHandle.USETEMPFILE, "true");
If you enable this mode you will need to periodically clean up the generated temporary files in your working directory. All OpenXLS temporary file names begin with "ExtenXLS_".

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONVERTMULBLANKS` This is
`static Writer`	`dump_input` A Writer to which a record dump should be written on input.
`static int`	`FORMAT_XLS` Format constant for BIFF8 (Excel '97-2007).
`static int`	`FORMAT_XLSM` Format constant for macro-enabled OOXML (Excel 2007).
`static int`	`FORMAT_XLSX` Format constant for normal OOXML (Excel 2007).
`static int`	`FORMAT_XLTM` Format constant for macro-enabled OOXML template (Excel 2007).
`static int`	`FORMAT_XLTX` Format constant for OOXML template (Excel 2007).
`protected WorkBook`	`mybook`
`protected WorkBookFactory`	`myfactory`
`protected LEOFile`	`myLEOFile`
`protected ProgressListener`	`plist`
`static int`	`RECURSION_LEVELS_ALLOWED` How many recursion levels to allow formulas to be calculated before throwing a circular reference error
`static SimpleDateFormat`	`simpledateformat`

Fields inherited from class io.starter.OpenXLS.DocumentHandle
DEBUGLEVEL, file, FORMAT_NATIVE, name, workingdir

Fields inherited from interface io.starter.OpenXLS.WorkBook
ALLOWDUPES, CALC_MODE_PROP, CALCULATE_ALWAYS, CALCULATE_AUTO, CALCULATE_EXPLICIT, DEFAULTENCODING, REFTRACK_PROP, SHAREDUPES, STRING_ENCODING_AUTO, STRING_ENCODING_COMPRESSED, STRING_ENCODING_UNICODE, UNICODEENCODING, USETEMPFILE_PROP, VALIDATEWORKBOOK

Fields inherited from interface io.starter.OpenXLS.Document
DEBUG_HIGH, DEBUG_LOW, DEBUG_MEDIUM

Constructor Summary

Constructors
Modifier	Constructor and Description
	`WorkBookHandle()` Default constructor creates a new, empty Spreadsheet with 3 WorkSheets: "Sheet1","Sheet2",and "Sheet3".
	`WorkBookHandle(boolean Excel2007)` Constructor creates a new, empty Spreadsheet with 3 worksheets: "Sheet1", "Sheet2" and "Sheet3" This version allows flagging the workbook as Excel 2007 format.
	`WorkBookHandle(byte[] barray)` Create a new WorkBookHandle from the byte array passed in.
	`WorkBookHandle(File fx)` constructor which takes the XLS file
	`WorkBookHandle(InputStream inx)` constructor which takes an InputStream containing the bytes of a valid XLS file.
`protected`	`WorkBookHandle(LEOFile leo)` For internal creation of a workbook handle from
	`WorkBookHandle(ProgressListener pn)` Constructor which takes a ProgressListener which monitors the progress of creating a new Excel file.
	`WorkBookHandle(String filePath)` Constructor which takes the XLS file name(
	`WorkBookHandle(String filePath, int debug)` constructor which takes the XLS file name and has an optional debug setting to assist with output.
	`WorkBookHandle(String fname, ProgressListener pn)` Constructor which takes the XLS file name and a ProgressListener which monitors the progress of reading the Excel file.
	`WorkBookHandle(URL url)` Fetches a workbook from a URL If you need to authenticate your URL connection first then use the InputStream constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`addSheetFromWorkBook(WorkBookHandle sourceBook, String sourceSheetName, String destSheetName)` Deprecated. - use addWorkSheet(WorkSheetHandle sht, String NewSheetName){
`boolean`	`addSheetFromWorkBookWithFormatting(WorkBookHandle sourceBook, String sourceSheetName, String destSheetName)` Deprecated. - use addWorkSheet(WorkSheetHandle sht, String NewSheetName){
`WorkSheetHandle`	`addWorkSheet(WorkSheetHandle sourceSheet)` Inserts a WorkSheetHandle from a separate WorkBookhandle into the current WorkBookHandle.
`WorkSheetHandle`	`addWorkSheet(WorkSheetHandle sourceSheet, String NewSheetName)` Inserts a WorkSheetHandle from a separate WorkBookhandle into the current WorkBookHandle.
`void`	`calculateFormulas()` Forces immediate recalculation of every formula in the workbook.
`void`	`close()` Closes the WorkBook and releases resources.
`void`	`copyChartToSheet(ChartHandle chart, WorkSheetHandle sheet)` Copies an existing Chart to another WorkSheet
`void`	`copyChartToSheet(String chartname, String sheetname)` Copies an existing Chart to another WorkSheet
`WorkSheetHandle`	`copyWorkSheet(String SourceSheetName, String NewSheetName)` Copy (duplicate) a worksheet in the workbook and add it to the end of the workbook with a new name
`ChartHandle`	`createChart(String name, WorkSheetHandle wsh)` Creates a new Chart and places it at the end of the workbook
`NameHandle`	`createNamedRange(String name, String rangeDef)` Create a named range in the workbook Note that the named range designation can conform to excel specs, that is, boolean values, references, or string variables can be set.
`WorkSheetHandle`	`createWorkSheet(String name)` Creates a new worksheet and places it at the end of the workbook.
`WorkSheetHandle`	`createWorkSheet(String name, int sheetpos)` Creates a new worksheet and places it at the specified position.
`void`	`deleteChart(String chartname, WorkSheetHandle wsh)` delete an existing chart of the workbook
`protected void`	`finalize()`
`WorkSheetHandle`	`getActiveSheet()` returns the active or selected worksheet tab
`String[]`	`getAllStrings()` Returns all strings that are in the SharedStringTable for this workbook.
`byte[]`	`getBytes()` Deprecated. Writing the spreadsheet to a byte array uses a great deal of memory and generally provides no benefit over streaming output. Use the `write(java.lang.String)` family of methods instead. If you need a byte array use `ByteArrayOutputStream`.
`CellHandle`	`getCell(String address)` Returns the Cell at the specified Location
`CellRange[]`	`getCellRanges()` Returns an Array of the CellRanges existing in this WorkBook specifically the Ranges referenced in Formulas, Charts, and Named Ranges.
`CellHandle[]`	`getCells()` Returns an array containing all cells in the WorkBook
`ChartHandle`	`getChart(String chartname)` Returns a Chart Handle
`ChartHandle`	`getChartById(int id)` retrieve a ChartHandle via id
`ChartHandle[]`	`getCharts()` Returns all Chart Handles contained in the WorkBook
`Color[]`	`getColorTable()` Get either the default color table, or the color table from the custom palatte(if exists) from the WorkBook
`FormatHandle[]`	`getConditionalFormats()` Returns an array of all Conditional Formats in the workbook these are formats referenced and used by the conditionally formatted ranges in the workbook.
`DateConverter.DateFormat`	`getDateFormat()` Gets the date format used by this book.
`WorkBookFactory`	`getFactory()` Gets the internal Factory object.
`String`	`getFileExtension()` Gets the file name extension for this document's native format.
`int`	`getFormat()` Gets the constant representing this document's native format.
`int`	`getFormat(String path)` Gets the constant representing this document's desired format
`FormatHandle[]`	`getFormats()` Returns an array of all FormatHandles in the workbook
`int`	`getFormulaCalculationMode()` Get the calculation mode for the workbook.
`FormulaHandle`	`getFormulaHandle(String celladdress)` Returns a Formula Handle
`ImageHandle`	`getImage(String imagename)` Returns an ImageHandle for manipulating images in the WorkBook
`ImageHandle[]`	`getImages()` Returns all ImageHandles in the workbook
`boolean`	`getIsExcel2007()` Returns whether the underlying spreadsheet is in Excel 2007 format by default.
`LEOFile`	`getLEOFile()` Gets the internal LEOFile object.
`String`	`getName()` Returns the name of this WorkBook
`NameHandle`	`getNamedRange(String rangename)` Returns a Named Range Handle
`NameHandle`	`getNamedRangeInScope(String rangename)` Returns a Named Range Handle if it exists in the specified scope.
`NameHandle[]`	`getNamedRanges()` Returns all Named Range Handles
`NameHandle[]`	`getNamedRangesInScope()` Returns all Named Range Handles scoped to WorkBook.
`WorkBookHandle`	`getNoSheetWorkBook()` Returns a WorkBookHandle containing an empty version of this WorkBook.
`int`	`getNumCells()` Returns the number of Cells in this WorkBook
`int`	`getNumWorkSheets()` Returns the number of Sheets in this WorkBook
`PivotTableHandle`	`getPivotTable(String ptname)` get a handle to a PivotTable in the WorkBook
`PivotTableHandle[]`	`getPivotTables()` get an array of handles to all PivotTables in the WorkBook
`protected static byte[]`	`getPrototypeBook()`
`protected static byte[]`	`getPrototypeChart()`
`protected static byte[]`	`getPrototypeSheet()`
`String`	`getStats()` Return useful statistics about this workbook.
`String`	`getStats(boolean usehtml)` Return useful statistics about this workbook.
`WorkBook`	`getWorkBook()` Returns a low-level WorkBook.
`String`	`getWorkingDirectory()`
`WorkSheetHandle`	`getWorkSheet(int sheetnum)` returns the handle to a WorkSheet by number.
`WorkSheetHandle`	`getWorkSheet(String handstr)` returns the handle to a WorkSheet by name.
`WorkSheetHandle[]`	`getWorkSheets()` Returns an array of handles to all of the WorkSheets in the Workbook.
`String`	`getXLSVersionString()` Returns the lowest version of Excel compatible with the input file.
`protected void`	`initBytes(BlockByteReader blockByteReader)` init the new WorkBookHandle
`protected void`	`initDefault()` another handle to the useful ability to load a book from the prorotype bytes
`protected void`	`initFromFile(File fx)` do all initialization with a filename
`protected void`	`initFromStream(InputStream input)` Initialize this workbook from a stream, unfortunately our byte backer requires a file, so create a tempfile and init from that
`protected void`	`initializeFromByteArray(byte[] barray)` Protected method that handles WorkBookHandle(byte[]) constructor
`void`	`initSharedFormulas()`
`protected void`	`initWorkBookFactory()`
`boolean`	`is1904()` Deprecated. Use `getDateFormat()` instead.
`void`	`markFormulasDirty()` Marks every formula in the workbook as needing a recalc.
`void`	`recalc()` Recalculates all dirty formulas in the workbook immediately.
`void`	`removeAllWorkSheets()` Removes all of the WorkSheets from this WorkBook.
`void`	`reset()` Resets the document state to what it was when it was loaded.
`int`	`searchAndReplace(String searchfor, String replacewith)` Searches all Cells in the workbook for the string occurrence and replaces with the replacement text.
`void`	`setDefaultColWidth(int t)` Set the default column width across all worksheets This setting is a worksheet level setting, so will be applied to all existing worksheets.
`void`	`setDefaultRowHeight(int t)` set Default row height in twips (=1/20 of a point) Note: only affects undefined Rows containing Cells
`void`	`setDupeStringMode(int mode)` Set Duplicate String Handling Mode.
`void`	`setFormulaCalculationMode(int CalcMode)` Set the calculation mode for the workbook.
`static void`	`setFormulaRecursionLevels(int recursion_allowed)` Set the recursion levels allowed for formulas calculated in this workbook before a circular reference is thrown.
`void`	`setIsExcel2007(boolean isExcel2007)` Sets whether this Workbook is in Excel 2007 format.
`void`	`setProtected(boolean protect)` set the workbook to protected mode Note: the password cannot be decrypted or changed in Excel -- protection can only be set/removed using OpenXLS
`void`	`setShowSheetTabs(boolean show)` Sets whether the sheet selection tabs should be shown.
`void`	`setStringEncodingMode(int mode)` Set Encoding mode of new Strings added to file.
`boolean`	`showSheetTabs()` Returns whether the sheet selection tabs should be shown.
`FormatHandle`	`transferExternalFormatHandle(FormatHandle externalFormat)` Utility method to copy a format handle from a separate WorkBookHandle to this WorkBookHandle
`void`	`write(OutputStream dest, boolean ooxml)` Deprecated. The boolean format parameter is not flexible enough to represent all supported formats. Use `write(OutputStream,int)` instead.
`void`	`write(OutputStream dest, int format)` Writes the document to the given stream in the requested format.
`void`	`write(String path)` Deprecated. The filename-based format choosing is counter-intuitive and failure-prone. Use `write(OutputStream,int)` instead.
`void`	`write(String path, boolean ooxml)` Deprecated. The boolean format parameter is not flexible enough to represent all supported formats. Use `DocumentHandle.write(File,int)` instead.
`StringBuffer`	`writeBytes(OutputStream dest)` Deprecated. Use `write(OutputStream,int)` instead.
`void`	`writeXLSXBytes(OutputStream dest)` Deprecated. Use `#write(OutputStream,int`) instead.
`void`	`writeXLSXBytes(OutputStream dest, int format)` Deprecated. This method is like `write(OutputStream,int)` except it only supports OOXML formats. Use that instead.

Methods inherited from class io.starter.OpenXLS.DocumentHandle
addProperty, getDebugLevel, getFile, getFileFromURL, getFileName, getInstance, getProperties, getProperty, getVersion, setDebugLevel, setFile, setFileName, setName, setProperties, setStreamingSheets, toString, write, write, write

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.starter.OpenXLS.WorkBook
addProperty, getProperty, setDebugLevel, setName, toString

Methods inherited from interface io.starter.OpenXLS.Document
write, write, write

- Field Detail
  - dump_input
```
public static Writer dump_input
```
    A Writer to which a record dump should be written on input. This is used by the dumping code in WorkBookFactory.
  - mybook
```
protected WorkBook mybook
```
  - myLEOFile
```
protected LEOFile myLEOFile
```
  - myfactory
```
protected WorkBookFactory myfactory
```
  - plist
```
protected ProgressListener plist
```
  - FORMAT_XLS
```
public static final int FORMAT_XLS
```
    Format constant for BIFF8 (Excel '97-2007).
    
    See Also:
    
    Constant Field Values
  - FORMAT_XLSX
```
public static final int FORMAT_XLSX
```
    Format constant for normal OOXML (Excel 2007).
    
    See Also:
    
    Constant Field Values
  - FORMAT_XLSM
```
public static final int FORMAT_XLSM
```
    Format constant for macro-enabled OOXML (Excel 2007).
    
    See Also:
    
    Constant Field Values
  - FORMAT_XLTX
```
public static final int FORMAT_XLTX
```
    Format constant for OOXML template (Excel 2007).
    
    See Also:
    
    Constant Field Values
  - FORMAT_XLTM
```
public static final int FORMAT_XLTM
```
    Format constant for macro-enabled OOXML template (Excel 2007).
    
    See Also:
    
    Constant Field Values
  - simpledateformat
```
public static SimpleDateFormat simpledateformat
```
  - RECURSION_LEVELS_ALLOWED
```
public static int RECURSION_LEVELS_ALLOWED
```
    How many recursion levels to allow formulas to be calculated before throwing a circular reference error
  - CONVERTMULBLANKS
```
public static String CONVERTMULBLANKS
```
    This is
- Constructor Detail
  - WorkBookHandle
```
public WorkBookHandle()
```
    Default constructor creates a new, empty Spreadsheet with 3 WorkSheets: "Sheet1","Sheet2",and "Sheet3".
  - WorkBookHandle
```
public WorkBookHandle(boolean Excel2007)
```
    Constructor creates a new, empty Spreadsheet with 3 worksheets: "Sheet1", "Sheet2" and "Sheet3"
    This version allows flagging the workbook as Excel 2007 format.
    Excel 2007 format contains larger maximum column and row contraints, for example.
    Even if the workbook is set to Excel 2007 format, it is still possible to write out the file as a BIFF8 (Excel 97-2003) file, but unsupported features will be dropped, and some files could experience corruption.
    
    Parameters:
    
    boolean - Excel2007 - true if set to Excel 2007 version
  - WorkBookHandle
```
public WorkBookHandle(InputStream inx)
```
    constructor which takes an InputStream containing the bytes of a valid XLS file.
    
    Parameters:
    
    InputStream - contains the valid BIFF8 bytes for reading
  - WorkBookHandle
```
public WorkBookHandle(byte[] barray)
```
    Create a new WorkBookHandle from the byte array passed in. Byte array passed in must contain a valid xls or xlsx workbook file
    
    Parameters:
    
    byte[] - byte array containing the valid XLS or XLSX file for reading
  - WorkBookHandle
```
public WorkBookHandle(URL url)
```
    Fetches a workbook from a URL If you need to authenticate your URL connection first then use the InputStream constructor
    
    Parameters:
    
    urlx -
    
    Throws:
    
    Exception
  - WorkBookHandle
```
public WorkBookHandle(String filePath)
```
    Constructor which takes the XLS file name(
    
    Parameters:
    
    String - filePath the name of the XLS file to read
  - WorkBookHandle
```
public WorkBookHandle(String filePath,
                      int debug)
```
    constructor which takes the XLS file name and has an optional debug setting to assist with output. Setting this value will cause verbose logging and is discouraged unless required for support.
    
    Parameters:
    
    String - filePath the name of the XLS file to read
    
    Debug - level
  - WorkBookHandle
```
public WorkBookHandle(File fx)
```
    constructor which takes the XLS file
    
    Parameters:
    
    File - the XLS file to read
    
    Debug - level
  - WorkBookHandle
```
public WorkBookHandle(ProgressListener pn)
```
    Constructor which takes a ProgressListener which monitors the progress of creating a new Excel file.
    
    Parameters:
    
    ProgressListener - object which is monitoring progress of WorkBook read
  - WorkBookHandle
```
public WorkBookHandle(String fname,
                      ProgressListener pn)
```
    Constructor which takes the XLS file name and a ProgressListener which monitors the progress of reading the Excel file.
    
    Parameters:
    
    String - fname the name of the XLS file to read
    
    ProgressListener - object which is monitoring progress of WorkBook read
  - WorkBookHandle
```
protected WorkBookHandle(LEOFile leo)
```
    For internal creation of a workbook handle from
    
    Parameters:
    
    leo -
- Method Detail
  - getPrototypeBook
```
protected static byte[] getPrototypeBook()
                                  throws IOException
```
    Throws:
    
    IOException
  - getPrototypeSheet
```
protected static byte[] getPrototypeSheet()
```
  - getPrototypeChart
```
protected static byte[] getPrototypeChart()
```
  - getFactory
```
public WorkBookFactory getFactory()
```
    Gets the internal Factory object.
    WARNING: This method is not part of the public API. Its use is not supported and behavior is subject to change.
  - getLEOFile
```
public LEOFile getLEOFile()
```
    Gets the internal LEOFile object.
    WARNING: This method is not part of the public API. Its use is not supported and behavior is subject to change.
  - searchAndReplace
```
public int searchAndReplace(String searchfor,
                            String replacewith)
```
    Searches all Cells in the workbook for the string occurrence and replaces with the replacement text.
    
    Returns:
    
    the number of replacements that were made
  - getAllStrings
```
public String[] getAllStrings()
```
    Returns all strings that are in the SharedStringTable for this workbook. The SST contains all standard string records in cells, but may not include such things as strings that are contained within formulas. This is useful for such things as full text indexing of workbooks
    
    Returns:
    
    Strings in the workbook.
  - getColorTable
```
public Color[] getColorTable()
```
    Get either the default color table, or the color table from the custom palatte(if exists) from the WorkBook
    
    Specified by:
    
    getColorTable in interface WorkBook
    
    Returns:
  - is1904
```
@Deprecated
public boolean is1904()
```
    Deprecated. Use getDateFormat() instead.
    
    Returns whether this book uses the 1904 date format.
  - getDateFormat
```
public DateConverter.DateFormat getDateFormat()
```
    Gets the date format used by this book.
    
    Specified by:
    
    getDateFormat in interface WorkBook
  - getXLSVersionString
```
public String getXLSVersionString()
```
    Returns the lowest version of Excel compatible with the input file.
    
    Returns:
    
    an Excel version string
  - getStats
```
public String getStats(boolean usehtml)
```
    Return useful statistics about this workbook.
    
    Parameters:
    
    use - html line breaks
    
    Returns:
    
    a string contatining various statistics.
  - getStats
```
public String getStats()
```
    Return useful statistics about this workbook.
    
    Returns:
    
    a string contatining various statistics.
  - getCell
```
public CellHandle getCell(String address)
                   throws CellNotFoundException,
                          WorkSheetNotFoundException
```
    Returns the Cell at the specified Location
    
    Specified by:
    
    getCell in interface WorkBook
    
    Parameters:
    
    address -
    
    Returns:
    
    Throws:
    
    CellNotFoundException
    
    WorkSheetNotFoundException
  - getCellRanges
```
public CellRange[] getCellRanges()
```
    Returns an Array of the CellRanges existing in this WorkBook specifically the Ranges referenced in Formulas, Charts, and Named Ranges. This is necessary to allow for automatic updating of references when adding/removing/moving Cells within these ranges, as well as shifting references to Cells in Formulas when Formula records are moved.
    
    Returns:
    
    all existing Cell Range references used in Formulas, Charts, and Names
  - getPivotTable
```
public PivotTableHandle getPivotTable(String ptname)
                               throws PivotTableNotFoundException
```
    get a handle to a PivotTable in the WorkBook
    
    Specified by:
    
    getPivotTable in interface WorkBook
    
    Parameters:
    
    String - name of the PivotTable
    
    Returns:
    
    PivotTable the PivotTable
    
    Throws:
    
    PivotTableNotFoundException
  - getPivotTables
```
public PivotTableHandle[] getPivotTables()
                                  throws PivotTableNotFoundException
```
    get an array of handles to all PivotTables in the WorkBook
    
    Specified by:
    
    getPivotTables in interface WorkBook
    
    Returns:
    
    PivotTable[] all of the WorkBooks PivotTables
    
    Throws:
    
    PivotTableNotFoundException
  - setFormulaCalculationMode
```
public void setFormulaCalculationMode(int CalcMode)
```
    Set the calculation mode for the workbook. CALCULATE_AUTO is the default for new workbooks. Calling Cell.getVal() will calculate formulas if they exist within the cell. CALCULATE_EXPLICIT will return present, cached value of the cell. Formula calculation will ONLY occur when explicitly called through the Formula Handle.calculate() method. CALCULATE_ALWAYS will ignore the cache and force a recalc every time a cell value is requested. WorkBookHandle.CALCULATE_AUTO WorkBookHandle.CALCULATE_ALWAYS WorkBookHandle.CALCULATE_EXPLICIT
    
    Specified by:
    
    setFormulaCalculationMode in interface WorkBook
    
    Parameters:
    
    CalcMode - Calculation mode to use in workbook.
  - getFormulaCalculationMode
```
public int getFormulaCalculationMode()
```
    Get the calculation mode for the workbook. CALCULATE_ALWAYS is the default for new workbooks. Calling Cell.getVal() will calculate formulas if they exist within the cell. CALCULATE_EXPLICIT will return present value of the cell. Formula calculation will only occur when explicitly called through the Formula Handle WorkBookHandle.CALCULATE_ALWAYS -- recalc every time the cell value is requested (no cacheing) WorkBookHandle.CALCULATE_EXPLICIT -- recalc only when FormulaHandle.calculate() called WorkBookHandle.CALCULATE_AUTO -- only recac when changes
    
    Specified by:
    
    getFormulaCalculationMode in interface WorkBook
    
    Parameters:
    
    CalcMode - Calculation mode to use in workbook.
  - setProtected
```
public void setProtected(boolean protect)
```
    set the workbook to protected mode Note: the password cannot be decrypted or changed in Excel -- protection can only be set/removed using OpenXLS
    
    Specified by:
    
    setProtected in interface WorkBook
    
    Parameters:
    
    boolean - whether to protect the book
  - setDefaultRowHeight
```
public void setDefaultRowHeight(int t)
```
    set Default row height in twips (=1/20 of a point) Note: only affects undefined Rows containing Cells
    
    Specified by:
    
    setDefaultRowHeight in interface WorkBook
    
    Parameters:
    
    int - Default Row Height
  - setDefaultColWidth
```
public void setDefaultColWidth(int t)
```
    Set the default column width across all worksheets
    This setting is a worksheet level setting, so will be applied to all existing worksheets. individual worksheets can also be set using WorkSheetHandle.setDefaultColWidth This setting is roughly the width of the character '0' The default width of a column is 8.
    
    Specified by:
    
    setDefaultColWidth in interface WorkBook
  - getFormulaHandle
```
public FormulaHandle getFormulaHandle(String celladdress)
                               throws FormulaNotFoundException
```
    Returns a Formula Handle
    
    Returns:
    
    FormulaHandle a formula handle in the WorkBook
    
    Throws:
    
    FormulaNotFoundException
  - getImages
```
public ImageHandle[] getImages()
```
    Returns all ImageHandles in the workbook
    
    Returns:
  - getImage
```
public ImageHandle getImage(String imagename)
                     throws ImageNotFoundException
```
    Returns an ImageHandle for manipulating images in the WorkBook
    
    Parameters:
    
    imagename -
    
    Returns:
    
    Throws:
    
    ImageNotFoundException
  - getNamedRange
```
public NameHandle getNamedRange(String rangename)
                         throws CellNotFoundException
```
    Returns a Named Range Handle
    
    Specified by:
    
    getNamedRange in interface WorkBook
    
    Returns:
    
    NameHandle a Named range in the WorkBook
    
    Throws:
    
    CellNotFoundException
  - getNamedRangeInScope
```
public NameHandle getNamedRangeInScope(String rangename)
                                throws CellNotFoundException
```
    Returns a Named Range Handle if it exists in the specified scope. This can be used to distinguish between multiple named ranges with the same name but differing scopes
    
    Returns:
    
    NameHandle a Named range in the WorkBook that exists in the scope
    
    Throws:
    
    CellNotFoundException
  - createNamedRange
```
public NameHandle createNamedRange(String name,
                                   String rangeDef)
```
    Create a named range in the workbook Note that the named range designation can conform to excel specs, that is, boolean values, references, or string variables can be set. Remember to utilize the sheet name when setting referential names. NameHandle nh = createNamedRange("cellRange", "Sheet1!A1:B3"); NameHandle nh = createNamedRange("trueRange", "=true");
    
    Parameters:
    
    name - The name that should be used to reference this named range
    
    rangeDef - Range of the cells for this named range, in excel syntax including sheet name, ie "Sheet1!A1:D1"
    
    Returns:
    
    NameHandle for modifying the named range
  - getChart
```
public ChartHandle getChart(String chartname)
                     throws ChartNotFoundException
```
    Returns a Chart Handle
    
    Specified by:
    
    getChart in interface WorkBook
    
    Returns:
    
    ChartHandle a Chart in the WorkBook
    
    Throws:
    
    ChartNotFoundException
  - getCharts
```
public ChartHandle[] getCharts()
```
    Returns all Chart Handles contained in the WorkBook
    
    Specified by:
    
    getCharts in interface WorkBook
    
    Returns:
    
    ChartHandle[] an array of all Charts in the WorkBook
  - getChartById
```
public ChartHandle getChartById(int id)
                         throws ChartNotFoundException
```
    retrieve a ChartHandle via id
    
    Parameters:
    
    id -
    
    Returns:
    
    Throws:
    
    ChartNotFoundException
  - getNamedRanges
```
public NameHandle[] getNamedRanges()
```
    Returns all Named Range Handles
    
    Specified by:
    
    getNamedRanges in interface WorkBook
    
    Returns:
    
    NameHandle[] all of the Named ranges in the WorkBook
  - getNamedRangesInScope
```
public NameHandle[] getNamedRangesInScope()
```
    Returns all Named Range Handles scoped to WorkBook. Note this will not include worksheet scoped named ranges
    
    Returns:
    
    NameHandle[] all of the Named ranges that are scoped to WorkBook
  - getName
```
public String getName()
```
    Returns the name of this WorkBook
    
    Specified by:
    
    getName in interface Document
    
    Specified by:
    
    getName in interface WorkBook
    
    Overrides:
    
    getName in class DocumentHandle
    
    Returns:
    
    String name of WorkBook
  - getCells
```
public CellHandle[] getCells()
```
    Returns an array containing all cells in the WorkBook
    
    Specified by:
    
    getCells in interface WorkBook
    
    Returns:
    
    CellHandle array of all book cells
  - getNumCells
```
public int getNumCells()
```
    Returns the number of Cells in this WorkBook
    
    Specified by:
    
    getNumCells in interface WorkBook
    
    Returns:
    
    int number of Cells
  - showSheetTabs
```
public boolean showSheetTabs()
```
    Returns whether the sheet selection tabs should be shown.
  - setShowSheetTabs
```
public void setShowSheetTabs(boolean show)
```
    Sets whether the sheet selection tabs should be shown.
  - getBytes
```
@Deprecated
public byte[] getBytes()
```
    Deprecated. Writing the spreadsheet to a byte array uses a great deal of memory and generally provides no benefit over streaming output. Use the write(java.lang.String) family of methods instead. If you need a byte array use ByteArrayOutputStream.
    
    Gets the spreadsheet as a byte array in BIFF8 (Excel '97-2003) format.
    
    Specified by:
    
    getBytes in interface WorkBook
    
    Returns:
    
    byte[] the XLS File's bytes
  - write
```
@Deprecated
public void write(String path)
```
    Deprecated. The filename-based format choosing is counter-intuitive and failure-prone. Use write(OutputStream,int) instead.
    
    Writes the document to the given path. If the filename ends with ".xlsx" or ".xlsm", the workbook will be written as OOXML (XLSX). Otherwise it will be written as BIFF8 (XLS). For OOXML, if the file has a VBA project the file extension must be ".xlsm". It will be changed if necessary.
    
    Parameters:
    
    path - the path to which the document should be written
  - write
```
@Deprecated
public void write(String path,
                              boolean ooxml)
```
    Deprecated. The boolean format parameter is not flexible enough to represent all supported formats. Use DocumentHandle.write(File,int) instead.
    
    Writes the document to the given file in either XLS or XLSX. For OOXML, if the file has a VBA project the file extension must be ".xlsm". It will be changed if necessary.
    
    Parameters:
    
    path - the path to which the document should be written
    
    ooxml - If true, write as OOXML (XLSX). Otherwise, write as BIFF8 (XLS).
  - write
```
@Deprecated
public void write(OutputStream dest,
                              boolean ooxml)
```
    Deprecated. The boolean format parameter is not flexible enough to represent all supported formats. Use write(OutputStream,int) instead.
    
    Writes the document to the given stream in either XLS or XLSX format.
    
    Parameters:
    
    dest - the stream to which the document should be written
    
    ooxml - If true, write as OOXML (XLSX). Otherwise, write as BIFF8 (XLS).
  - getFormat
```
public int getFormat()
```
    Gets the constant representing this document's native format.
    
    Specified by:
    
    getFormat in class DocumentHandle
  - getFormat
```
public int getFormat(String path)
```
    Gets the constant representing this document's desired format
  - getFileExtension
```
public String getFileExtension()
```
    Description copied from class: DocumentHandle
    
    Gets the file name extension for this document's native format.
    
    Specified by:
    
    getFileExtension in class DocumentHandle
  - write
```
public void write(OutputStream dest,
                  int format)
           throws IOException
```
    Writes the document to the given stream in the requested format.
    format choices:
    WorkBookHandle.FORMAT_XLS for 2003 and previous versions
    WorkBookHandle.FORMAT_XLSX for non-macro-enabled 2007 version
    WorkBookHandle.FORMAT_XLSM for macro-enabled 2007 version
    WorkBookHandle.FORMAT_XLTM for macro-enabled 2007 templates.
    WorkBookHandle.FORMAT_XLTX for 2007 templates,
    IMPORTANT NOTE: if the resulting filename contains the .XLSM extension
    the WorkBook MUST be written in FORMAT_XLSM; otherwise open errors will occur
    NOTE: If the format is FORMAT_XLSX and the filename contains macros
    the file will be written as Macro-Enabled i.e. in FORMAT_XLSM. In these cases,
    the filename must contain the .XLSM extension
    
    Specified by:
    
    write in interface Document
    
    Specified by:
    
    write in class DocumentHandle
    
    Parameters:
    
    dest - the stream to which the document should be written
    
    format - the constant representing the desired output format
    
    Throws:
    
    IllegalArgumentException - if the given type code is invalid
    
    IOException - if an error occurs while writing to the stream
  - writeXLSXBytes
```
@Deprecated
public void writeXLSXBytes(OutputStream dest,
                                       int format)
                                throws Exception
```
    Deprecated. This method is like write(OutputStream,int) except it only supports OOXML formats. Use that instead.
    
    Writes the document to the given stream in the requested OOXML format.
    
    Parameters:
    
    dest - the stream to which the document should be written
    
    format - the constant representing the desired output format
    
    Throws:
    
    IllegalArgumentException - if the given type code is invalid
    
    IOException - if an error occurs while writing to the stream
    
    Exception
  - writeXLSXBytes
```
@Deprecated
public void writeXLSXBytes(OutputStream dest)
                                throws Exception
```
    Deprecated. Use #write(OutputStream,int) instead.
    
    Writes the document to the given stream in the default OOXML format.
    
    Parameters:
    
    dest - the stream to which the document should be written
    
    Throws:
    
    IOException - if an error occurs while writing to the stream
    
    Exception
  - getIsExcel2007
```
public boolean getIsExcel2007()
```
    Returns whether the underlying spreadsheet is in Excel 2007 format by default. Even if this method returns true, it is still possible to write out the file as a BIFF8 (Excel 97-2003) file, but unsupported features will be dropped, and some files could experience corruption.
    
    Returns:
    
    whether the underlying spreadsheet is Excel 2007 format
  - setIsExcel2007
```
public void setIsExcel2007(boolean isExcel2007)
```
    Sets whether this Workbook is in Excel 2007 format. Excel 2007 format contains larger maximum column and row contraints, for example.
    Even if the workbook is set to Excel 2007 format, it is still possible to write out the file as a BIFF8 (Excel 97-2003) file, but unsupported features will be dropped, and some files could experience corruption.
    
    Parameters:
    
    isExcel2007 -
  - writeBytes
```
@Deprecated
public StringBuffer writeBytes(OutputStream dest)
```
    Deprecated. Use write(OutputStream,int) instead.
    
    Writes the document to the given stream in BIFF8 (XLS) format.
    To output a debugging StringBuffer, you must first set the autolockdown setting:
    props.put("io.starter.OpenXLS.autocreatelockdown","true");
    
    Specified by:
    
    writeBytes in interface WorkBook
    
    Parameters:
    
    dest - the stream to which the document should be written
    
    Returns:
    
    for debugging: a StringBuffer containing an output of the record bytes streamed
  - initDefault
```
protected void initDefault()
```
    another handle to the useful ability to load a book from the prorotype bytes
  - initFromStream
```
protected void initFromStream(InputStream input)
```
    Initialize this workbook from a stream, unfortunately our byte backer requires a file, so create a tempfile and init from that
  - initializeFromByteArray
```
protected void initializeFromByteArray(byte[] barray)
```
    Protected method that handles WorkBookHandle(byte[]) constructor
    
    Parameters:
    
    barray -
  - initWorkBookFactory
```
protected void initWorkBookFactory()
```
  - initFromFile
```
protected void initFromFile(File fx)
```
    do all initialization with a filename
    
    Parameters:
    
    fname -
  - initBytes
```
protected void initBytes(BlockByteReader blockByteReader)
```
    init the new WorkBookHandle
  - close
```
public void close()
```
    Closes the WorkBook and releases resources.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - reset
```
public void reset()
```
    Description copied from class: DocumentHandle
    
    Resets the document state to what it was when it was loaded.
    
    Specified by:
    
    reset in interface Document
    
    Specified by:
    
    reset in interface WorkBook
    
    Specified by:
    
    reset in class DocumentHandle
  - getWorkSheets
```
public WorkSheetHandle[] getWorkSheets()
```
    Returns an array of handles to all of the WorkSheets in the Workbook.
    
    Specified by:
    
    getWorkSheets in interface WorkBook
    
    Returns:
    
    WorkSheetHandle[] Array of all WorkSheets in WorkBook
  - getWorkSheet
```
public WorkSheetHandle getWorkSheet(int sheetnum)
                             throws WorkSheetNotFoundException
```
    returns the handle to a WorkSheet by number. Sheet 0 is the first Sheet.
    
    Specified by:
    
    getWorkSheet in interface WorkBook
    
    Parameters:
    
    index - of worksheet (ie: 0)
    
    Returns:
    
    WorkSheetHandle the WorkSheet
    
    Throws:
    
    WorkSheetNotFoundException - if the specified WorkSheet is not found in the WorkBook.
  - getWorkSheet
```
public WorkSheetHandle getWorkSheet(String handstr)
                             throws WorkSheetNotFoundException
```
    returns the handle to a WorkSheet by name.
    
    Specified by:
    
    getWorkSheet in interface WorkBook
    
    Parameters:
    
    String - name of worksheet (ie: "Sheet1")
    
    Returns:
    
    WorkSheetHandle the WorkSheet
    
    Throws:
    
    WorkSheetNotFoundException - if the specified WorkSheet is not found in the WorkBook.
  - getActiveSheet
```
public WorkSheetHandle getActiveSheet()
                               throws WorkSheetNotFoundException
```
    returns the active or selected worksheet tab
    
    Returns:
    
    WorkSheetHandle
    
    Throws:
    
    WorkSheetNotFoundException
  - getWorkBook
```
public WorkBook getWorkBook()
```
    Returns a low-level WorkBook. NOTE: The WorkBook class is NOT a part of the published API. Any of the methods and/or variables on a WorkBook object are subject to change without notice in new versions of OpenXLS.
    
    Specified by:
    
    getWorkBook in interface WorkBook
  - setStringEncodingMode
```
public void setStringEncodingMode(int mode)
```
    Set Encoding mode of new Strings added to file. OpenXLS has 3 modes for handling the internal encoding of String data that is added to the file. OpenXLS can save space in the file if it knows that all characters in your String data can be represented with a single byte (Compressed.) If your String contains characters which need 2 bytes to represent (such as Eastern-language characters) then it needs to be stored in an uncompressed Unicode format. OpenXLS can either automatically detect the mode for each String, or you can set it explicitly. The auto mode is the most flexible but requires processing overhead. Default mode is WorkBookHandle.STRING_ENCODING_AUTO. Valid Modes Are: WorkBookHandle.STRING_ENCODING_AUTO Use if you are adding mixed Unicode and non-unicode Strings and can accept the performance hit -slowest String adds -optimal file size for mixed Strings WorkBookHandle.STRING_ENCODING_UNICODE Use if all of your new Strings are Unicode - faster than AUTO -faster than AUTO -largest file size WorkBookHandle.STRING_ENCODING_COMPRESSED Use if all of your new Strings are non-Unicode and can have high-bytes compressed -faster than AUTO -smallest file size
    
    Specified by:
    
    setStringEncodingMode in interface WorkBook
    
    Parameters:
    
    int - String Encoding Mode
  - setDupeStringMode
```
public void setDupeStringMode(int mode)
```
    Set Duplicate String Handling Mode.
```
             The Duplicate String Mode determines the behavior of
             the String table when inserting new Strings.
             
             The String table shares a single entry for multiple
             Cells containing the same string.  When multiple Cells
             have the same value, they share the same underlying string.
             
             Changing the value of any one of the Cells will change
             the value for any Cells sharing that reference.
             
             For this reason, you need to determine
             the handling of new strings added to the sheet that
             are duplicates of strings already in the table.
             
             If you will be changing the values of these
             new Cells, you will need to set the Duplicate
             String Mode to ALLOWDUPES.  If the string table
             encounters a duplicate entry being added, it
             will insert a duplicate that can then be subsequently
             changed without affecting the other duplicate Cells.
             
             Valid Modes Are:
             
                 WorkBookHandle.ALLOWDUPES - faster String inserts, larger file sizes,  changing Cells has no effect on dupe Cells                   
        
                 WorkBookHandle.SHAREDUPES - slower inserts, dupe smaller file sizes, Cells share changes
 
```
    Specified by:
    
    setDupeStringMode in interface WorkBook
    
    Parameters:
    
    int - Duplicate String Handling Mode
  - copyChartToSheet
```
public void copyChartToSheet(String chartname,
                             String sheetname)
                      throws ChartNotFoundException,
                             WorkSheetNotFoundException
```
    Copies an existing Chart to another WorkSheet
    
    Specified by:
    
    copyChartToSheet in interface WorkBook
    
    Parameters:
    
    chartname -
    
    sheetname -
    
    Throws:
    
    ChartNotFoundException
    
    WorkSheetNotFoundException
  - copyChartToSheet
```
public void copyChartToSheet(ChartHandle chart,
                             WorkSheetHandle sheet)
                      throws ChartNotFoundException,
                             WorkSheetNotFoundException
```
    Copies an existing Chart to another WorkSheet
    
    Specified by:
    
    copyChartToSheet in interface WorkBook
    
    Parameters:
    
    chart -
    
    sheet -
    
    Throws:
    
    ChartNotFoundException
    
    WorkSheetNotFoundException
  - copyWorkSheet
```
public WorkSheetHandle copyWorkSheet(String SourceSheetName,
                                     String NewSheetName)
                              throws WorkSheetNotFoundException
```
    Copy (duplicate) a worksheet in the workbook and add it to the end of the workbook with a new name
    
    Specified by:
    
    copyWorkSheet in interface WorkBook
    
    Parameters:
    
    String - the Name of the source worksheet;
    
    String - the Name of the new (destination) worksheet;
    
    Returns:
    
    the new WorkSheetHandle
    
    Throws:
    
    WorkSheetNotFoundException
  - calculateFormulas
```
public void calculateFormulas()
```
    Forces immediate recalculation of every formula in the workbook.
    
    Specified by:
    
    calculateFormulas in interface WorkBook
    
    Throws:
    
    FunctionNotSupportedException - if an unsupported function is used by any formula in the workbook
    
    See Also:
    
    #forceRecalc(), recalc()
  - markFormulasDirty
```
public void markFormulasDirty()
```
    Marks every formula in the workbook as needing a recalc. This method does not actually calculate formulas, for that use recalc().
  - recalc
```
public void recalc()
```
    Recalculates all dirty formulas in the workbook immediately.
    You generally need not call this method. Dirty formulas will automatically be recalculated when their values are queried. This method is only useful for forcing calculation to occur at a certain time. In the case of functions such as NOW() whose value is volatile the formula will still be recalculated every time it is queried.
    
    Throws:
    
    FunctionNotSupportedException - if an unsupported function is used by any formula in the workbook
    
    See Also:
    
    markFormulasDirty()
  - removeAllWorkSheets
```
public void removeAllWorkSheets()
```
    Removes all of the WorkSheets from this WorkBook. Bytes streamed from this WorkBook will create invalid Spreadsheet files unless a WorkSheet(s) are added to it. NOTE: A WorkBook with no sheets is *invalid* and will not open in Excel. You must add sheets to this WorkBook for it to be valid.
    
    Specified by:
    
    removeAllWorkSheets in interface WorkBook
  - getNoSheetWorkBook
```
public WorkBookHandle getNoSheetWorkBook()
```
    Returns a WorkBookHandle containing an empty version of this WorkBook. Use in conjunction with addSheetFromWorkBook() to create new output WorkBooks containing various sheets from a master template. ie: WorkBookHandle emptytemplate = this.getNoSheetWorkBook(); emptytemplate.addSheetFromWorkBook(this, "Sheet1", "TargetSheet");
    
    Specified by:
    
    getNoSheetWorkBook in interface WorkBook
    
    Returns:
    
    WorkBookHandle - the empty WorkBookHandle duplicate
    
    See Also:
    
    addSheetFromWorkBook
  - addSheetFromWorkBook
```
@Deprecated
public boolean addSheetFromWorkBook(WorkBookHandle sourceBook,
                                                String sourceSheetName,
                                                String destSheetName)
                                         throws WorkSheetNotFoundException
```
    Deprecated. - use addWorkSheet(WorkSheetHandle sht, String NewSheetName){
    
    Inserts a worksheet from a Source WorkBook.
    
    Specified by:
    
    addSheetFromWorkBook in interface WorkBook
    
    Parameters:
    
    sourceBook - - the WorkBook containing the sheet to copy
    
    sourceSheetName - - the name of the sheet to copy
    
    destSheetName - - the name of the new sheet in this workbook
    
    Throws:
    
    WorkSheetNotFoundException
  - addSheetFromWorkBookWithFormatting
```
@Deprecated
public boolean addSheetFromWorkBookWithFormatting(WorkBookHandle sourceBook,
                                                              String sourceSheetName,
                                                              String destSheetName)
                                                       throws WorkSheetNotFoundException
```
    Deprecated. - use addWorkSheet(WorkSheetHandle sht, String NewSheetName){
    
    Inserts a worksheet from a Source WorkBook. Brings all string data and formatting information from the source workbook. Be aware this is programmatically creating a large amount of new formatting information in the destination workbook. A higher performance option will usually be using getNoSheetWorkbook and addSheetFromWorkBook.
    
    Parameters:
    
    sourceBook - - the WorkBook containing the sheet to copy
    
    sourceSheetName - - the name of the sheet to copy
    
    destSheetName - - the name of the new sheet in this workbook
    
    Throws:
    
    WorkSheetNotFoundException
  - addWorkSheet
```
public WorkSheetHandle addWorkSheet(WorkSheetHandle sourceSheet)
```
    Inserts a WorkSheetHandle from a separate WorkBookhandle into the current WorkBookHandle. copies charts, images, formats from source workbook Worksheet will be the same name as in the source workbook. To add a custom named worksheet use the addWorkSheet(WorkSheetHandle, String sheetname) method
    
    Parameters:
    
    WorkSheetHandle - the source WorkSheetHandle;
  - addWorkSheet
```
public WorkSheetHandle addWorkSheet(WorkSheetHandle sourceSheet,
                                    String NewSheetName)
```
    Inserts a WorkSheetHandle from a separate WorkBookhandle into the current WorkBookHandle. copies charts, images, formats from source workbook
    
    Specified by:
    
    addWorkSheet in interface WorkBook
    
    Parameters:
    
    WorkSheetHandle - the source WorkSheetHandle;
    
    String - the Name of the new (destination) worksheet;
  - transferExternalFormatHandle
```
public FormatHandle transferExternalFormatHandle(FormatHandle externalFormat)
```
    Utility method to copy a format handle from a separate WorkBookHandle to this WorkBookHandle
    
    Parameters:
    
    externalFormat - - FormatHandle from an external WorkBookHandle
    
    Returns:
  - createChart
```
public ChartHandle createChart(String name,
                               WorkSheetHandle wsh)
```
    Creates a new Chart and places it at the end of the workbook
    
    Parameters:
    
    String - the Name of the newly created Chart
    
    Returns:
    
    the new ChartHandle
  - deleteChart
```
public void deleteChart(String chartname,
                        WorkSheetHandle wsh)
                 throws ChartNotFoundException
```
    delete an existing chart of the workbook
    
    Parameters:
    
    chartname -
    
    Throws:
    
    ChartNotFoundException
  - getNumWorkSheets
```
public int getNumWorkSheets()
```
    Returns the number of Sheets in this WorkBook
    
    Returns:
    
    int number of Sheets
  - createWorkSheet
```
public WorkSheetHandle createWorkSheet(String name,
                                       int sheetpos)
```
    Creates a new worksheet and places it at the specified position. The new sheet will be inserted before the sheet currently at the given index. If the given index is higher than the last index currently in use, the sheet will be added to the end of the workbook and will receive an index one higher than that of the current final sheet. If the given index is negative it will be interpreted as 0.
    
    Parameters:
    
    name - the name of the newly created worksheet
    
    sheetpos - the index at which the sheet should be inserted
    
    Returns:
    
    the new WorkSheetHandle
  - createWorkSheet
```
public WorkSheetHandle createWorkSheet(String name)
```
    Creates a new worksheet and places it at the end of the workbook.
    
    Specified by:
    
    createWorkSheet in interface WorkBook
    
    Parameters:
    
    name - the name of the newly created worksheet
    
    Returns:
    
    the new WorkSheetHandle
  - getFormats
```
public FormatHandle[] getFormats()
```
    Returns an array of all FormatHandles in the workbook
    
    Specified by:
    
    getFormats in interface WorkBook
    
    Returns:
    
    all existing FormatHandles in the workbook
  - getConditionalFormats
```
public FormatHandle[] getConditionalFormats()
```
    Returns an array of all Conditional Formats in the workbook these are formats referenced and used by the conditionally formatted ranges in the workbook.
    
    Returns:
  - setFormulaRecursionLevels
```
public static void setFormulaRecursionLevels(int recursion_allowed)
```
    Set the recursion levels allowed for formulas calculated in this workbook before a circular reference is thrown. Default setting is 250 levels of recursion
    
    Parameters:
    
    recursion_allowed -
  - getWorkingDirectory
```
public String getWorkingDirectory()
```
  - initSharedFormulas
```
public void initSharedFormulas()
```

Class WorkBookHandle

Field Summary

Fields inherited from class io.starter.OpenXLS.DocumentHandle

Fields inherited from interface io.starter.OpenXLS.WorkBook

Fields inherited from interface io.starter.OpenXLS.Document

Constructor Summary

Method Summary

Methods inherited from class io.starter.OpenXLS.DocumentHandle

Methods inherited from class java.lang.Object

Methods inherited from interface io.starter.OpenXLS.WorkBook

Methods inherited from interface io.starter.OpenXLS.Document

Field Detail

dump_input

mybook

myLEOFile

myfactory

plist

FORMAT_XLS

FORMAT_XLSX

FORMAT_XLSM

FORMAT_XLTX

FORMAT_XLTM

simpledateformat

RECURSION_LEVELS_ALLOWED

CONVERTMULBLANKS

Constructor Detail

WorkBookHandle

WorkBookHandle

WorkBookHandle

WorkBookHandle

WorkBookHandle

WorkBookHandle

WorkBookHandle

WorkBookHandle

WorkBookHandle

WorkBookHandle

WorkBookHandle

Method Detail

getPrototypeBook

getPrototypeSheet

getPrototypeChart

getFactory

getLEOFile

searchAndReplace

getAllStrings

getColorTable

is1904

getDateFormat

getXLSVersionString

getStats

getStats

getCell

getCellRanges

getPivotTable

getPivotTables

setFormulaCalculationMode

getFormulaCalculationMode

setProtected

setDefaultRowHeight

setDefaultColWidth

getFormulaHandle

getImages

getImage

getNamedRange

getNamedRangeInScope

createNamedRange

getChart

getCharts

getChartById

getNamedRanges

getNamedRangesInScope

getName

getCells

getNumCells

showSheetTabs

setShowSheetTabs

getBytes

write

write

write