IWorkbook

All Known Implementing Classes:

Workbook
```
public interface IWorkbook
```
Represents an IWorkbook object.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDataSource(java.lang.String name, java.lang.Object dataSource)` Add data source for template
`void`	`calculate()` Calculates formulas of the workbook as needed.
`void`	`dirty()` Designates all the formulas of the workbook to be recalculated when the next calculation occurs.
`java.util.List<JsonError>`	`fromJson(java.io.InputStream stream)` Generates a workbook from a json stream.
`java.util.List<JsonError>`	`fromJson(java.io.InputStream stream, DeserializationOptions deserializationOptions)` Generates a workbook from a json stream.
`java.util.List<JsonError>`	`fromJson(java.lang.String json)` Generates a workbook from a json string.
`java.util.List<JsonError>`	`fromJson(java.lang.String json, DeserializationOptions deserializationOptions)` Generates a workbook from a json string.
`IWorksheet`	`getActiveSheet()` Returns an object that represents the active sheet (the sheet on top) in the active workbook or in the specified window or workbook.
`Event<EventHandler<EventArgs>>`	`getAfterSaveEvent()` Occurs after the workbook is saved.
`boolean`	`getAllowDynamicArray()` Deprecated.
`java.lang.String`	`getAuthor()` Gets the author.
`boolean`	`getAutoParse()` Gets whether to automatically parse when setting a range value to a string value.
`boolean`	`getAutoRoundValue()` Gets whether to round the number to 15 significant figures when getting the value.
`Event<EventHandler<EventArgs>>`	`getBeforeSaveEvent()` Occurs before the workbook is saved.
`IWorkbookView`	`getBookView()` Returns an object that represents the view settings of this workbook.
`IBuiltInDocumentPropertyCollection`	`getBuiltInDocumentProperties()` Gets a collection that represents all the built-in document properties of the workbook.
`java.util.Locale`	`getCulture()` Gets culture info for the workbook.
`ICustomDocumentPropertyCollection`	`getCustomDocumentProperties()` Gets a collection that represents all the custom document properties of the workbook.
`ICustomViews`	`getCustomViews()` Gets the custom views of the workbook.
`java.lang.String`	`getDefaultTableStyle()` Gets the table style name from the `ITableStyleCollection` collection that is used as the default TableStyle.
`boolean`	`getDeferUpdateDirtyState()` Gets whether update the dirty state of the formula cells immediately when changing the value of a cell.
`boolean`	`getEnableCalculation()` Gets whether the calculation engine is valid.
`java.util.List<java.lang.String>`	`getExcelLinkSources()` Returns the names of the linked excel documents.
`java.lang.String`	`getFullName()` Returns the name of the workbook, including its path on disk.
`IGraphicsInfo`	`getGraphicsInfo()` Provides graphics information.
`IIconSets`	`getIconSets()` Filters data in a workbook based on a cell icon from the IconSets collection.
`java.lang.String`	`getName()` Gets a string value that represents the name of the workbook.
`INames`	`getNames()` Returns the `INames` collection that represents all the names in the specified workbook (including all worksheet-specific names).
`Event<EventHandler<SheetEventArgs>>`	`getNewSheetEvent()` Occurs when a new sheet is created in the workbook.
`Event<EventHandler<EventArgs>>`	`getOpenedEvent()` Occurs when the workbook is opened.
`IExcelOptions`	`getOptions()` Returns the `IExcelOptions` object that represents some settings to control workbook behavior.
`java.lang.String`	`getPath()` Gets a string that represents the path to the workbook file that this workbook object represents.
`IPivotCaches`	`getPivotCaches()` Returns the `IPivotCaches` collection that represents all the `IPivotTable` caches in the specified workbook.
`boolean`	`getProtectStructure()` True if the order of the sheets in the workbook is protected.
`boolean`	`getProtectWindows()` True if the windows of the workbook are protected.
`ReferenceStyle`	`getReferenceStyle()` Gets the reference style.
`boolean`	`getResetAdjacentRangeBorder()` Determines whether to reset adjacent range's border when setting border for a range.
`IWorksheets`	`getSelectedSheets()` Returns a `IWorksheets` collection that represents all the selected sheets in the specified workbook.
`Event<EventHandler<SheetEventArgs>>`	`getSheetActivateEvent()` Occurs when a sheet is activate.
`Event<EventHandler<SheetEventArgs>>`	`getSheetBeforeDeleteEvent()` Occurs before a sheet is deleted.
`Event<EventHandler<RangeEventArgs>>`	`getSheetChangeEvent()` Occurs when something changes in the cells of a sheet.
`Event<EventHandler<SheetEventArgs>>`	`getSheetDeactivateEvent()` Occurs when a sheet is deactivated.
`Event<EventHandler<RangeEventArgs>>`	`getSheetSelectionChange()` Occurs when the selection changes on a sheet.
`ISignatureSet`	`getSignatures()` Gets a collection of Signature objects that correspond to the digital signature attached to a document.
`ISlicerCaches`	`getSlicerCaches()` Gets the `ISlicerCaches` object associated with the workbook.
`IStyleCollection`	`getStyles()` Returns the `IStyleCollection` collection that represents all the styles in the specified workbook.
`ITableStyleCollection`	`getTableStyles()` Returns the `ITableStyleCollection` collection object for the current workbook that refers to the styles used in the current workbook.
`ITheme`	`getTheme()` Returns the theme applied to the current workbook.
`java.util.List<FontInfo>`	`getUsedFonts()` Gets all fonts information that used on workbook.
`IWorksheets`	`getWorksheets()` Returns the `IWorksheets` collection that represents all the worksheets in the specified workbook.
`WriteProtection`	`getWriteProtection()` Returns a `WriteProtection` object that provides access to the workbook write protection options.
`boolean`	`isEncryptedFile(java.io.InputStream fileStream)` Specifies whether the file is password protected.
`boolean`	`isEncryptedFile(java.lang.String fileName)` Specifies whether the file is password protected.
`void`	`open(java.io.InputStream fileStream)` Opens the specified excel file stream.
`void`	`open(java.io.InputStream fileStream, OpenFileFormat fileFormat)` Opens the specified format file stream.
`void`	`open(java.io.InputStream fileStream, OpenOptionsBase options)` Opens the stream with specified options, the open options can be XlsxOpenOptions, CsvOpenOptions.
`void`	`open(java.io.InputStream fileStream, java.lang.String password)` Opens the specified excel file stream.
`void`	`open(java.lang.String fileName)` Opens the specified excel file
`java.util.List<JsonError>`	`open(java.lang.String fileName, DeserializationOptions deserializationOptions)` Opens the json file.
`void`	`open(java.lang.String fileName, OpenFileFormat fileFormat)` Opens the specified format file.
`void`	`open(java.lang.String fileName, OpenOptionsBase options)` Opens the file with specified options, the open options can be XlsxOpenOptions, CSVOpenOptions.
`void`	`open(java.lang.String fileName, java.lang.String password)` Opens the specified excel file
`void`	`processTemplate()` Start to process the template
`void`	`protect()` Protects a workbook so that it cannot be modified.
`void`	`protect(boolean structure)` Protects a workbook so that it cannot be modified.
`void`	`protect(boolean structure, boolean windows)` Protects a workbook so that it cannot be modified.
`void`	`protect(java.lang.String password)` Protects a workbook so that it cannot be modified.
`void`	`protect(java.lang.String password, boolean structure)` Protects a workbook so that it cannot be modified.
`void`	`protect(java.lang.String password, boolean structure, boolean windows)` Protects a workbook so that it cannot be modified.
`void`	`save(java.io.OutputStream outputStream)` Saves the workbook to the stream.
`void`	`save(java.io.OutputStream fileStream, SaveFileFormat fileFormat)` Saves the specified format file stream.
`void`	`save(java.io.OutputStream fileStream, SaveOptionsBase options)` Saves workbook to stream with specified options.
`void`	`save(java.io.OutputStream outputStream, java.lang.String password)` Saves data to the specified excel file stream.
`void`	`save(java.lang.String fileName)` Saves the workbook to the disk.
`void`	`save(java.lang.String fileName, SaveFileFormat fileFormat)` Saves the specified format file.
`void`	`save(java.lang.String fileName, SaveOptionsBase options)` Saves workbook to file with specified options.
`void`	`save(java.lang.String fileName, java.lang.String password)` Saves data to the specified excel file.
`void`	`setAllowDynamicArray(boolean value)` Deprecated.
`void`	`setAuthor(java.lang.String value)` Sets the author.
`void`	`setAutoParse(boolean value)` Sets whether to automatically parse when setting a range value to a string value.
`void`	`setAutoRoundValue(boolean value)` Sets whether to round the number to 15 significant figures when getting the value.
`void`	`setCulture(java.util.Locale value)` Sets culture info for the workbook.
`void`	`setDefaultTableStyle(java.lang.String value)` Sets the table style name from the `ITableStyleCollection` collection that is used as the default TableStyle.
`void`	`setDeferUpdateDirtyState(boolean value)` Sets whether update the dirty state of the formula cells immediately when changing the value of a cell.
`void`	`setEnableCalculation(boolean value)` Sets whether the calculation engine is valid.
`void`	`setGraphicsInfo(IGraphicsInfo value)` Provides graphics information.
`void`	`setName(java.lang.String name)` Sets a string value that represents the name of the workbook.
`void`	`setPath(java.lang.String path)` Sets a string that represents the path to the workbook file that this workbook object represents.
`void`	`setReferenceStyle(ReferenceStyle value)` Sets the reference style.
`void`	`setResetAdjacentRangeBorder(boolean value)` Determines whether to reset adjacent range's border when setting border for a range.
`void`	`setTheme(ITheme value)` Sets the theme applied to the current workbook.
`java.lang.String`	`toJson()` Generates a json string from a workbook.
`void`	`toJson(java.io.OutputStream stream)` Generates a json stream from a workbook.
`void`	`toJson(java.io.OutputStream stream, SerializationOptions serializationOptions)` Generates a json stream from a workbook.
`java.lang.String`	`toJson(SerializationOptions serializationOptions)` Generates a json string from the workbook.
`void`	`unprotect()` Removes protection from the workbook.
`void`	`unprotect(java.lang.String password)` Removes protection from the workbook.
`void`	`updateExcelLink(java.lang.String name)` Updates a excel link.
`void`	`updateExcelLink(java.lang.String name, IWorkbook sourceWorkbook)` Updates a excel link.
`void`	`updateExcelLinks()` Updates all the excel links.

- Method Detail
  - getAfterSaveEvent
```
Event<EventHandler<EventArgs>> getAfterSaveEvent()
```
    Occurs after the workbook is saved.
  - getBeforeSaveEvent
```
Event<EventHandler<EventArgs>> getBeforeSaveEvent()
```
    Occurs before the workbook is saved.
  - getNewSheetEvent
```
Event<EventHandler<SheetEventArgs>> getNewSheetEvent()
```
    Occurs when a new sheet is created in the workbook.
  - getOpenedEvent
```
Event<EventHandler<EventArgs>> getOpenedEvent()
```
    Occurs when the workbook is opened.
  - getSheetActivateEvent
```
Event<EventHandler<SheetEventArgs>> getSheetActivateEvent()
```
    Occurs when a sheet is activate.
  - getSheetBeforeDeleteEvent
```
Event<EventHandler<SheetEventArgs>> getSheetBeforeDeleteEvent()
```
    Occurs before a sheet is deleted.
  - getSheetChangeEvent
```
Event<EventHandler<RangeEventArgs>> getSheetChangeEvent()
```
    Occurs when something changes in the cells of a sheet.
  - getSheetDeactivateEvent
```
Event<EventHandler<SheetEventArgs>> getSheetDeactivateEvent()
```
    Occurs when a sheet is deactivated.
  - getSheetSelectionChange
```
Event<EventHandler<RangeEventArgs>> getSheetSelectionChange()
```
    Occurs when the selection changes on a sheet.
  - getAllowDynamicArray
```
@Deprecated
boolean getAllowDynamicArray()
```
    Deprecated.
    
    Gets whether allow dynamic array formula.This method is obsoleted, please use getFormula2() to get dynamic array formula.
  - setAllowDynamicArray
```
@Deprecated
void setAllowDynamicArray(boolean value)
```
    Deprecated.
    
    Sets whether allow dynamic array formula.This method is obsoleted, please use setFormula2() to set dynamic array formula.
  - getDeferUpdateDirtyState
```
boolean getDeferUpdateDirtyState()
```
    Gets whether update the dirty state of the formula cells immediately when changing the value of a cell.
  - setDeferUpdateDirtyState
```
void setDeferUpdateDirtyState(boolean value)
```
    Sets whether update the dirty state of the formula cells immediately when changing the value of a cell.
  - getName
```
java.lang.String getName()
```
    Gets a string value that represents the name of the workbook.
  - setName
```
void setName(java.lang.String name)
```
    Sets a string value that represents the name of the workbook.
  - getFullName
```
java.lang.String getFullName()
```
    Returns the name of the workbook, including its path on disk.
  - getPath
```
java.lang.String getPath()
```
    Gets a string that represents the path to the workbook file that this workbook object represents.
  - setPath
```
void setPath(java.lang.String path)
```
    Sets a string that represents the path to the workbook file that this workbook object represents.
  - getSelectedSheets
```
IWorksheets getSelectedSheets()
```
    Returns a IWorksheets collection that represents all the selected sheets in the specified workbook.
  - getOptions
```
IExcelOptions getOptions()
```
    Returns the IExcelOptions object that represents some settings to control workbook behavior.
  - getResetAdjacentRangeBorder
```
boolean getResetAdjacentRangeBorder()
```
    Determines whether to reset adjacent range's border when setting border for a range. The default value of this property is true
  - setResetAdjacentRangeBorder
```
void setResetAdjacentRangeBorder(boolean value)
```
    Determines whether to reset adjacent range's border when setting border for a range. The default value of this property is true
    
    Parameters:
    
    value -
  - getAutoParse
```
boolean getAutoParse()
```
    Gets whether to automatically parse when setting a range value to a string value.
  - setAutoParse
```
void setAutoParse(boolean value)
```
    Sets whether to automatically parse when setting a range value to a string value.
  - getAutoRoundValue
```
boolean getAutoRoundValue()
```
    Gets whether to round the number to 15 significant figures when getting the value.
  - setAutoRoundValue
```
void setAutoRoundValue(boolean value)
```
    Sets whether to round the number to 15 significant figures when getting the value.
  - getBookView
```
IWorkbookView getBookView()
```
    Returns an object that represents the view settings of this workbook.
  - getProtectStructure
```
boolean getProtectStructure()
```
    True if the order of the sheets in the workbook is protected. Read-only Boolean.
  - getProtectWindows
```
boolean getProtectWindows()
```
    True if the windows of the workbook are protected. Read-only Boolean.
  - getSignatures
```
ISignatureSet getSignatures()
```
    Gets a collection of Signature objects that correspond to the digital signature attached to a document.
  - getBuiltInDocumentProperties
```
IBuiltInDocumentPropertyCollection getBuiltInDocumentProperties()
```
    Gets a collection that represents all the built-in document properties of the workbook.
  - getCustomDocumentProperties
```
ICustomDocumentPropertyCollection getCustomDocumentProperties()
```
    Gets a collection that represents all the custom document properties of the workbook.
  - getCustomViews
```
ICustomViews getCustomViews()
```
    Gets the custom views of the workbook.
  - getWriteProtection
```
WriteProtection getWriteProtection()
```
    Returns a WriteProtection object that provides access to the workbook write protection options.
  - getEnableCalculation
```
boolean getEnableCalculation()
```
    Gets whether the calculation engine is valid.
  - setEnableCalculation
```
void setEnableCalculation(boolean value)
```
    Sets whether the calculation engine is valid.
  - getCulture
```
java.util.Locale getCulture()
```
    Gets culture info for the workbook. Which influences the feature related culture.
  - setCulture
```
void setCulture(java.util.Locale value)
```
    Sets culture info for the workbook. Which influences the feature related culture.
  - getDefaultTableStyle
```
java.lang.String getDefaultTableStyle()
```
    Gets the table style name from the ITableStyleCollection collection that is used as the default TableStyle.
  - setDefaultTableStyle
```
void setDefaultTableStyle(java.lang.String value)
```
    Sets the table style name from the ITableStyleCollection collection that is used as the default TableStyle.
  - getNames
```
INames getNames()
```
    Returns the INames collection that represents all the names in the specified workbook (including all worksheet-specific names).
  - getAuthor
```
java.lang.String getAuthor()
```
    Gets the author.
  - setAuthor
```
void setAuthor(java.lang.String value)
```
    Sets the author.
  - getPivotCaches
```
IPivotCaches getPivotCaches()
```
    Returns the IPivotCaches collection that represents all the IPivotTable caches in the specified workbook.
  - getReferenceStyle
```
ReferenceStyle getReferenceStyle()
```
    Gets the reference style.
  - setReferenceStyle
```
void setReferenceStyle(ReferenceStyle value)
```
    Sets the reference style.
  - getStyles
```
IStyleCollection getStyles()
```
    Returns the IStyleCollection collection that represents all the styles in the specified workbook.
  - getTableStyles
```
ITableStyleCollection getTableStyles()
```
    Returns the ITableStyleCollection collection object for the current workbook that refers to the styles used in the current workbook.
  - getTheme
```
ITheme getTheme()
```
    Returns the theme applied to the current workbook.
  - setTheme
```
void setTheme(ITheme value)
```
    Sets the theme applied to the current workbook.
  - getIconSets
```
IIconSets getIconSets()
```
    Filters data in a workbook based on a cell icon from the IconSets collection.
  - getWorksheets
```
IWorksheets getWorksheets()
```
    Returns the IWorksheets collection that represents all the worksheets in the specified workbook. This is a read-only Sheets object.
  - getActiveSheet
```
IWorksheet getActiveSheet()
```
    Returns an object that represents the active sheet (the sheet on top) in the active workbook or in the specified window or workbook. Returns null if no sheet is active.
  - getSlicerCaches
```
ISlicerCaches getSlicerCaches()
```
    Gets the ISlicerCaches object associated with the workbook.
  - calculate
```
void calculate()
```
    Calculates formulas of the workbook as needed.
  - dirty
```
void dirty()
```
    Designates all the formulas of the workbook to be recalculated when the next calculation occurs.
  - fromJson
```
java.util.List<JsonError> fromJson(java.lang.String json)
```
    Generates a workbook from a json string.
    
    Parameters:
    
    json - the json.
    
    Returns:
    
    the errors in the json.
  - fromJson
```
java.util.List<JsonError> fromJson(java.lang.String json,
                                   DeserializationOptions deserializationOptions)
```
    Generates a workbook from a json string.
    
    Parameters:
    
    json - the json.
    
    deserializationOptions - the DeserializationOptions object.
    
    Returns:
    
    the errors in the json.
  - fromJson
```
java.util.List<JsonError> fromJson(java.io.InputStream stream)
```
    Generates a workbook from a json stream.
    
    Parameters:
    
    stream - the stream
    
    Returns:
    
    the errors in the json.
  - fromJson
```
java.util.List<JsonError> fromJson(java.io.InputStream stream,
                                   DeserializationOptions deserializationOptions)
```
    Generates a workbook from a json stream.
    
    Parameters:
    
    stream - the stream
    
    deserializationOptions - the DeserializationOptions object.
    
    Returns:
    
    the errors in the json.
  - toJson
```
java.lang.String toJson()
```
    Generates a json string from a workbook.
    
    Returns:
    
    the json string.
  - toJson
```
java.lang.String toJson(SerializationOptions serializationOptions)
```
    Generates a json string from the workbook.
    
    Parameters:
    
    serializationOptions - the SerializationOptions object.
    
    Returns:
    
    The json string
  - toJson
```
void toJson(java.io.OutputStream stream)
```
    Generates a json stream from a workbook.
    
    Parameters:
    
    stream - the output stream.
  - toJson
```
void toJson(java.io.OutputStream stream,
            SerializationOptions serializationOptions)
```
    Generates a json stream from a workbook.
    
    Parameters:
    
    stream - the output stream.
    
    serializationOptions - the SerializationOptions object.
  - isEncryptedFile
```
boolean isEncryptedFile(java.lang.String fileName)
```
    Specifies whether the file is password protected.
    
    Parameters:
    
    fileName - the file name.
  - isEncryptedFile
```
boolean isEncryptedFile(java.io.InputStream fileStream)
```
    Specifies whether the file is password protected.
    
    Parameters:
    
    fileStream - the input file stream.
  - open
```
void open(java.lang.String fileName)
```
    Opens the specified excel file
    
    Parameters:
    
    fileName - The excel file.
  - open
```
java.util.List<JsonError> open(java.lang.String fileName,
                               DeserializationOptions deserializationOptions)
```
    Opens the json file.
    
    Parameters:
    
    fileName - The specified json file.
    
    deserializationOptions - The json deserialization options.
    
    Returns:
    
    Json errors
  - open
```
void open(java.lang.String fileName,
          java.lang.String password)
```
    Opens the specified excel file
    
    Parameters:
    
    fileName - The excel file.
    
    password - The password of the file.
  - open
```
void open(java.lang.String fileName,
          OpenOptionsBase options)
```
    Opens the file with specified options, the open options can be XlsxOpenOptions, CSVOpenOptions.
    
    Parameters:
    
    fileName - The excel file.
    
    options - The options of opening the file.
  - open
```
void open(java.lang.String fileName,
          OpenFileFormat fileFormat)
```
    Opens the specified format file.
    
    Parameters:
    
    fileName - The specified file.
    
    fileFormat - The format of the file.
  - open
```
void open(java.io.InputStream fileStream)
```
    Opens the specified excel file stream.
    
    Parameters:
    
    fileStream - The file stream.
  - open
```
void open(java.io.InputStream fileStream,
          java.lang.String password)
```
    Opens the specified excel file stream.
    
    Parameters:
    
    fileStream - The file stream.
    
    password - The password of the file.
  - open
```
void open(java.io.InputStream fileStream,
          OpenOptionsBase options)
```
    Opens the stream with specified options, the open options can be XlsxOpenOptions, CsvOpenOptions.
    
    Parameters:
    
    fileStream - The file stream.
    
    options - The format of opening the file stream.
  - open
```
void open(java.io.InputStream fileStream,
          OpenFileFormat fileFormat)
```
    Opens the specified format file stream.
    
    Parameters:
    
    fileStream - The specified file stream.
    
    fileFormat - The format of the file stream.
  - save
```
void save(java.lang.String fileName)
```
    Saves the workbook to the disk.
    
    Parameters:
    
    fileName - The file name.
  - save
```
void save(java.lang.String fileName,
          java.lang.String password)
```
    Saves data to the specified excel file.
    
    Parameters:
    
    fileName - The excel file.
    
    password - The password of the file.
  - save
```
void save(java.lang.String fileName,
          SaveOptionsBase options)
```
    Saves workbook to file with specified options. The option can be XlsxSaveOptions, CsvSaveOptions, HtmlSaveOptions
    
    Parameters:
    
    fileName - The specified file.
    
    options - The options of saving the file.
  - save
```
void save(java.lang.String fileName,
          SaveFileFormat fileFormat)
```
    Saves the specified format file.
    
    Parameters:
    
    fileName - The specified file.
    
    fileFormat - The format of the file.
  - save
```
void save(java.io.OutputStream outputStream)
```
    Saves the workbook to the stream.
    
    Parameters:
    
    outputStream - The file stream.
  - save
```
void save(java.io.OutputStream outputStream,
          java.lang.String password)
```
    Saves data to the specified excel file stream.
    
    Parameters:
    
    outputStream - The file stream.
    
    password - The password of the file.
  - save
```
void save(java.io.OutputStream fileStream,
          SaveOptionsBase options)
```
    Saves workbook to stream with specified options. The option can be XlsxSaveOptions, CsvSaveOptions, HtmlSaveOptions
    
    Parameters:
    
    fileStream - The specified file stream.
    
    options - The options of saving the file stream.
  - save
```
void save(java.io.OutputStream fileStream,
          SaveFileFormat fileFormat)
```
    Saves the specified format file stream.
    
    Parameters:
    
    fileStream - The specified file stream.
    
    fileFormat - The format of the file stream.
  - getUsedFonts
```
java.util.List<FontInfo> getUsedFonts()
```
    Gets all fonts information that used on workbook.
  - protect
```
void protect()
```
    Protects a workbook so that it cannot be modified.
  - protect
```
void protect(boolean structure)
```
    Protects a workbook so that it cannot be modified.
    
    Parameters:
    
    structure - True to protect the structure of the workbook (To prevent other users from viewing hidden worksheets, adding, moving, deleting, or hiding worksheets, and renaming worksheets).
  - protect
```
void protect(boolean structure,
             boolean windows)
```
    Protects a workbook so that it cannot be modified.
    
    Parameters:
    
    structure - True to protect the structure of the workbook (To prevent other users from viewing hidden worksheets, adding, moving, deleting, or hiding worksheets, and renaming worksheets).
    
    windows - True to prevent users from moving, resizing, or closing the workbook window, or hide/unhide windows. This option is available only in Excel 2007, Excel 2010, Excel for Mac 2011, and Excel 2016 for Mac.
  - protect
```
void protect(java.lang.String password)
```
    Protects a workbook so that it cannot be modified.
    
    Parameters:
    
    password - Password to protect the workbook.
  - protect
```
void protect(java.lang.String password,
             boolean structure)
```
    Protects a workbook so that it cannot be modified.
    
    Parameters:
    
    password - Password to protect the workbook.
    
    structure - True to protect the structure of the workbook (To prevent other users from viewing hidden worksheets, adding, moving, deleting, or hiding worksheets, and renaming worksheets).
  - protect
```
void protect(java.lang.String password,
             boolean structure,
             boolean windows)
```
    Protects a workbook so that it cannot be modified.
    
    Parameters:
    
    password - Password to protect the workbook.
    
    structure - True to protect the structure of the workbook (To prevent other users from viewing hidden worksheets, adding, moving, deleting, or hiding worksheets, and renaming worksheets).
    
    windows - True to prevent users from moving, resizing, or closing the workbook window, or hide/unhide windows. This option is available only in Excel 2007, Excel 2010, Excel for Mac 2011, and Excel 2016 for Mac.
  - unprotect
```
void unprotect()
```
    Removes protection from the workbook.
  - unprotect
```
void unprotect(java.lang.String password)
```
    Removes protection from the workbook.
    
    Parameters:
    
    password - Password to protect the workbook.
  - addDataSource
```
void addDataSource(java.lang.String name,
                   java.lang.Object dataSource)
```
    Add data source for template
    
    Parameters:
    
    name - : the alias name of the data source
    
    dataSource: - Can be object of ResultSet, Custom object and variable
  - processTemplate
```
void processTemplate()
```
    Start to process the template
  - getGraphicsInfo
```
IGraphicsInfo getGraphicsInfo()
```
    Provides graphics information. If this property doesn't have value, the workbook will use built-in graphic information.
  - setGraphicsInfo
```
void setGraphicsInfo(IGraphicsInfo value)
```
    Provides graphics information. If this property doesn't have value, the workbook will use built-in graphic information.
  - getExcelLinkSources
```
java.util.List<java.lang.String> getExcelLinkSources()
```
    Returns the names of the linked excel documents.
  - updateExcelLink
```
void updateExcelLink(java.lang.String name)
```
    Updates a excel link.
  - updateExcelLink
```
void updateExcelLink(java.lang.String name,
                     IWorkbook sourceWorkbook)
```
    Updates a excel link.
  - updateExcelLinks
```
void updateExcelLinks()
```
    Updates all the excel links.

Interface IWorkbook

Method Summary

Method Detail

getAfterSaveEvent

getBeforeSaveEvent

getNewSheetEvent

getOpenedEvent

getSheetActivateEvent

getSheetBeforeDeleteEvent

getSheetChangeEvent

getSheetDeactivateEvent

getSheetSelectionChange

getAllowDynamicArray

setAllowDynamicArray

getDeferUpdateDirtyState

setDeferUpdateDirtyState

getName

setName

getFullName

getPath

setPath

getSelectedSheets

getOptions

getResetAdjacentRangeBorder

setResetAdjacentRangeBorder

getAutoParse

setAutoParse

getAutoRoundValue

setAutoRoundValue

getBookView

getProtectStructure

getProtectWindows

getSignatures

getBuiltInDocumentProperties

getCustomDocumentProperties

getCustomViews

getWriteProtection

getEnableCalculation

setEnableCalculation

getCulture

setCulture

getDefaultTableStyle

setDefaultTableStyle

getNames

getAuthor

setAuthor

getPivotCaches

getReferenceStyle

setReferenceStyle

getStyles

getTableStyles

getTheme

setTheme

getIconSets

getWorksheets

getActiveSheet

getSlicerCaches

calculate

dirty

fromJson

fromJson

fromJson

fromJson

toJson

toJson

toJson

toJson

isEncryptedFile

isEncryptedFile

open

open

open

open

open

open

open

open

open

save

save