Workbook

java.lang.Object
- com.grapecity.documents.excel.Workbook

All Implemented Interfaces:: IWorkbook

public final class Workbook
extends java.lang.Object
implements IWorkbook

Represents a workbook.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String FontsFolderPath
Gets or sets the location of font files that will be used when exporting pdf.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`FontsFolderPath` Gets or sets the location of font files that will be used when exporting pdf.

Constructor Summary

Constructors
Constructor and Description

Workbook()
Creates the workbook.

Workbook(java.lang.String licenseKey)
Creates a workbook and apply the specified license.

Constructors
Constructor and Description
`Workbook()` Creates the workbook.
`Workbook(java.lang.String licenseKey)` Creates a workbook and apply the specified license.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`AddCustomFunction(CustomFunction func)` Add custom function into the function set.
`static void`	`AddCustomFunction(CustomFunction func, boolean canOverride)` Add custom function into the function set.
`void`	`addDataSource(java.lang.String name, java.lang.Object dataSource)` Add data source for template
`void`	`calculate()` Calculates formulas in the workbook as needed.
`void`	`calculateFull()` Forces to calculate all formulas of the workbook
`void`	`clear()` Clears data.
`Workbook`	`createWorkbook()`
`void`	`dirty()` Designates all the formulas of the workbook to be recalculated when the next calculation occurs.
`void`	`EnsureSelectedSheetsInitialized()`
`java.util.List<JsonError>`	`fromJson(java.io.InputStream stream)` Generates a workbook from the 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 the json string.
`java.util.List<JsonError>`	`fromJson(java.lang.String json, DeserializationOptions deserializationOptions)` Generates a workbook from a json string.
`IWorksheet`	`getActiveSheet()` Gets the active sheet.
`Event<EventHandler<EventArgs>>`	`getAfterSaveEvent()` Occurs after the workbook is saved.
`boolean`	`getAllowDynamicArray()` Deprecated.
`java.lang.String`	`getAuthor()` Gets the author.
`IAutoCorrect`	`getAutoCorrect()`
`boolean`	`getAutoParse()` Determines whether to parse automatically when setting range value to string value.
`boolean`	`getAutoRoundValue()` Determines 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 the culture info of workbook, default is Locale.getDefault().
`ExcelCultureInfo`	`getCultureInfo()` Internal use
`ICustomDocumentPropertyCollection`	`getCustomDocumentProperties()` Gets a collection that represents all the custom document properties of the workbook.
`ICustomViews`	`getCustomViews()` Gets a collection that represents all the custom document properties of the workbook.
`IWorkbookForShell`	`getData()`
`java.lang.String`	`getDefaultTableStyle()` Specifies the table style 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()` Specifies whether the calculation engine is working.
`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.
`IInternalHelper`	`getInternalHelper()` Internal use
`double`	`getMaxiumDigitWidth(GraphicsType point)`
`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).
`static java.lang.String[]`	`getNames(java.io.InputStream fileStream)` Gets all sheet names and tables names that will be used as the parameter source of ImportData. If the name is a table name, the worksheet name is qualified before the table name, such as "Sheet1!Table1".
`static java.lang.String[]`	`getNames(java.lang.String fileName)` Gets all sheet names and tables names that will be used as the parameter source of ImportData. If the name is a table name, the worksheet name is qualified before the table name, such as "Sheet1!Table1".
`Event<EventHandler<SheetEventArgs>>`	`getNewSheetEvent()` Occurs when a new sheet is created in the workbook.
`IFormatter`	`getNumberFormatter(java.lang.String formatCode)`
`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.
`IGraphicsCore`	`getPdfGraphics()`
`IGraphicsCore`	`getPDFGraphics()`
`IPivotCaches`	`getPivotCaches()` Gets a PivotCaches collection that represents all the PivotTable 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 active.
`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.
`StyleData`	`GetStyle(int styleID)`
`IStyleCollection`	`getStyles()` Provides access to the collection of cell styles in the current workbook.
`ITableStyleCollection`	`getTableStyles()` Gets the table styles used in the current workbook.
`static IJsonSerializer`	`getTagJsonSerializer()` Gets json serializer for custom type
`ITheme`	`getTheme()` Returns an instance of ITheme which provides access to the theme associated with a workbook.
`java.util.List<FontInfo>`	`getUsedFonts()` Gets all fonts information that are used on workbook.
`static IJsonSerializer`	`getValueJsonSerializer()` Gets json serializer for custom type
`IWorksheets`	`getWorksheets()` Gets a collection of worksheets contained in the workbook.
`WriteProtection`	`getWriteProtection()` Provides access to the workbook write protection options.
`static java.lang.Object[][]`	`importData(java.io.InputStream fileStream, java.lang.String sourceName)` Import all the data of the specified source of the file.
`static java.lang.Object[][]`	`importData(java.io.InputStream fileStream, java.lang.String worksheetName, int row, int column, int rowCount, int columnCount)` Import the data of a specified range from a fileStream.
`static java.lang.Object[][]`	`importData(java.lang.String fileName, java.lang.String sourceName)` Import all the data of the specified source of the file.
`static java.lang.Object[][]`	`importData(java.lang.String fileName, java.lang.String worksheetName, int row, int column, int rowCount, int columnCount)` Import the data of a specified range from a file.
`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 stream with specified file format.
`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)` Deprecated. Use `open(InputStream, OpenOptionsBase)` instead
`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 file with specified file format.
`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)` Deprecated. Use `open(String, OpenOptionsBase)` instead
`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 workbook to stream with specified file format.
`void`	`save(java.io.OutputStream fileStream, SaveOptionsBase options)` Saves workbook to stream with specified options, the option can be XlsxSaveOptions, CsvSaveOptions
`void`	`save(java.io.OutputStream outputStream, java.lang.String password)` Deprecated. Use `save(OutputStream, SaveOptionsBase)` instead
`void`	`save(java.lang.String fileName)` Saves the workbook to the disk.
`void`	`save(java.lang.String fileName, SaveFileFormat fileFormat)` Saves workbook to file with specified file format.
`void`	`save(java.lang.String fileName, SaveOptionsBase options)` Saves workbook to file with specified options, the option can be XlsxSaveOptions, CsvSaveOptions
`void`	`save(java.lang.String fileName, java.lang.String password)` Deprecated. Use `save(String, SaveOptionsBase)` instead
`void`	`SelectSheets(boolean replace, java.lang.Iterable<java.lang.String> selection)`
`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.
`static void`	`SetLicenseFile(java.lang.String licenseFilePath)` For licenses of the Chinese market, apply deployment license or unlimited dev license from file.
`static void`	`SetLicenseKey(java.lang.String key)` Sets license for all workbook instances.
`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.
`static void`	`setTagJsonSerializer(IJsonSerializer value)` Sets json serializer for custom type in from/to json.
`void`	`setTheme(ITheme value)` Sets the theme applied to the current workbook.
`static void`	`setValueJsonSerializer(IJsonSerializer value)` Sets json serializer for custom type in from/to json.
`java.lang.String`	`toJson()` Generates a json string from the workbook.
`void`	`toJson(java.io.OutputStream stream)` Generates a zipped json string from the 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.
`Color`	`ToRGBColor(ColorData color)`
`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.

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

- Field Detail
  - FontsFolderPath
```
public static java.lang.String FontsFolderPath
```
    Gets or sets the location of font files that will be used when exporting pdf.
- Constructor Detail
  - Workbook
```
public Workbook()
```
    Creates the workbook.
  - Workbook
```
public Workbook(java.lang.String licenseKey)
```
    Creates a workbook and apply the specified license.
    Important: For licenses of the Chinese market, use SetLicenseFile or set license in the GCEXCEL_JAVA_DEPLOY_LICENSE_V5 environment variable instead.
    
    Parameters:
    
    licenseKey - license key
- Method Detail
  - getAllowDynamicArray
```
@Deprecated
public boolean getAllowDynamicArray()
```
    Deprecated.
    
    Gets whether allow dynamic array formula. This method is obsoleted, please use getFormula2() to get dynamic array formula.
    
    Specified by:
    
    getAllowDynamicArray in interface IWorkbook
  - setAllowDynamicArray
```
@Deprecated
public void setAllowDynamicArray(boolean value)
```
    Deprecated.
    
    Sets whether allow dynamic array formula.This method is obsoleted, please use setFormula2() to set dynamic array formula.
    
    Specified by:
    
    setAllowDynamicArray in interface IWorkbook
  - getDeferUpdateDirtyState
```
public boolean getDeferUpdateDirtyState()
```
    Gets whether update the dirty state of the formula cells immediately when changing the value of a cell.
    
    Specified by:
    
    getDeferUpdateDirtyState in interface IWorkbook
  - setDeferUpdateDirtyState
```
public void setDeferUpdateDirtyState(boolean value)
```
    Sets whether update the dirty state of the formula cells immediately when changing the value of a cell.
    
    Specified by:
    
    setDeferUpdateDirtyState in interface IWorkbook
  - getName
```
public java.lang.String getName()
```
    Gets a string value that represents the name of the workbook.
    
    Specified by:
    
    getName in interface IWorkbook
  - setName
```
public void setName(java.lang.String name)
```
    Sets a string value that represents the name of the workbook.
    
    Specified by:
    
    setName in interface IWorkbook
  - getFullName
```
public java.lang.String getFullName()
```
    Returns the name of the workbook, including its path on disk.
    
    Specified by:
    
    getFullName in interface IWorkbook
  - getPath
```
public java.lang.String getPath()
```
    Gets a string that represents the path to the workbook file that this workbook object represents.
    
    Specified by:
    
    getPath in interface IWorkbook
  - setPath
```
public void setPath(java.lang.String path)
```
    Sets a string that represents the path to the workbook file that this workbook object represents.
    
    Specified by:
    
    setPath in interface IWorkbook
  - open
```
public void open(java.lang.String fileName)
```
    Opens the specified excel file
    
    Specified by:
    
    open in interface IWorkbook
    
    Parameters:
    
    fileName - The excel file.
  - open
```
public java.util.List<JsonError> open(java.lang.String fileName,
                                      DeserializationOptions deserializationOptions)
```
    Opens the json file.
    
    Specified by:
    
    open in interface IWorkbook
    
    Parameters:
    
    fileName - The specified json file.
    
    deserializationOptions - The json deserialization options.
    
    Returns:
    
    Json errors
  - open
```
@Deprecated
public void open(java.lang.String fileName,
                             java.lang.String password)
```
    Deprecated. Use open(String, OpenOptionsBase) instead
    
    Opens the specified excel file
    
    Specified by:
    
    open in interface IWorkbook
    
    Parameters:
    
    fileName - The excel file.
    
    password - The password of the file.
  - open
```
public void open(java.lang.String fileName,
                 OpenFileFormat fileFormat)
```
    Opens the file with specified file format.
    
    Specified by:
    
    open in interface IWorkbook
    
    Parameters:
    
    fileName - The specified file.
    
    fileFormat - The format of the file.
  - open
```
public void open(java.lang.String fileName,
                 OpenOptionsBase options)
```
    Opens the file with specified options, the open options can be XlsxOpenOptions, CsvOpenOptions.
    
    Specified by:
    
    open in interface IWorkbook
    
    Parameters:
    
    fileName - The excel file.
    
    options - The options of opening the file.
  - open
```
public final void open(java.io.InputStream fileStream)
```
    Opens the specified excel file stream.
    
    Specified by:
    
    open in interface IWorkbook
    
    Parameters:
    
    fileStream - The file stream.
  - open
```
@Deprecated
public void open(java.io.InputStream fileStream,
                             java.lang.String password)
```
    Deprecated. Use open(InputStream, OpenOptionsBase) instead
    
    Opens the specified excel file stream.
    
    Specified by:
    
    open in interface IWorkbook
    
    Parameters:
    
    fileStream - The file stream.
    
    password - The password of the file.
  - open
```
public void open(java.io.InputStream fileStream,
                 OpenFileFormat fileFormat)
```
    Opens the stream with specified file format.
    
    Specified by:
    
    open in interface IWorkbook
    
    Parameters:
    
    fileStream - The specified file stream.
    
    fileFormat - The format of the file stream.
  - open
```
public void open(java.io.InputStream fileStream,
                 OpenOptionsBase options)
```
    Opens the stream with specified options, the open options can be XlsxOpenOptions, CsvOpenOptions.
    
    Specified by:
    
    open in interface IWorkbook
    
    Parameters:
    
    fileStream - The file stream.
    
    options - The format of opening the file stream.
  - save
```
public void save(java.lang.String fileName)
```
    Saves the workbook to the disk.
    
    Specified by:
    
    save in interface IWorkbook
    
    Parameters:
    
    fileName - The file name.
  - save
```
@Deprecated
public void save(java.lang.String fileName,
                             java.lang.String password)
```
    Deprecated. Use save(String, SaveOptionsBase) instead
    
    Saves data to the specified excel file.
    
    Specified by:
    
    save in interface IWorkbook
    
    Parameters:
    
    fileName - The excel file.
    
    password - The password of the file.
  - save
```
public void save(java.lang.String fileName,
                 SaveOptionsBase options)
```
    Saves workbook to file with specified options, the option can be XlsxSaveOptions, CsvSaveOptions
    
    Specified by:
    
    save in interface IWorkbook
    
    Parameters:
    
    fileName - The specified file.
    
    options - The options of saving the file.
  - save
```
public void save(java.lang.String fileName,
                 SaveFileFormat fileFormat)
```
    Saves workbook to file with specified file format.
    
    Specified by:
    
    save in interface IWorkbook
    
    Parameters:
    
    fileName - The specified file.
    
    fileFormat - The format of the file.
  - save
```
public void save(java.io.OutputStream outputStream)
```
    Saves the workbook to the stream.
    
    Specified by:
    
    save in interface IWorkbook
    
    Parameters:
    
    outputStream - The file stream.
  - save
```
@Deprecated
public void save(java.io.OutputStream outputStream,
                             java.lang.String password)
```
    Deprecated. Use save(OutputStream, SaveOptionsBase) instead
    
    Saves data to the specified excel file stream.
    
    Specified by:
    
    save in interface IWorkbook
    
    Parameters:
    
    outputStream - The file stream.
    
    password - The password of the file.
  - save
```
public void save(java.io.OutputStream fileStream,
                 SaveOptionsBase options)
```
    Saves workbook to stream with specified options, the option can be XlsxSaveOptions, CsvSaveOptions
    
    Specified by:
    
    save in interface IWorkbook
    
    Parameters:
    
    fileStream - The specified file stream.
    
    options - The options of saving the file stream.
  - save
```
public void save(java.io.OutputStream fileStream,
                 SaveFileFormat fileFormat)
```
    Saves workbook to stream with specified file format.
    
    Specified by:
    
    save in interface IWorkbook
    
    Parameters:
    
    fileStream - The specified file stream.
    
    fileFormat - The format of the file stream.
  - getPdfGraphics
```
public IGraphicsCore getPdfGraphics()
```
  - getAfterSaveEvent
```
public Event<EventHandler<EventArgs>> getAfterSaveEvent()
```
    Occurs after the workbook is saved.
    
    Specified by:
    
    getAfterSaveEvent in interface IWorkbook
  - getBeforeSaveEvent
```
public Event<EventHandler<EventArgs>> getBeforeSaveEvent()
```
    Occurs before the workbook is saved.
    
    Specified by:
    
    getBeforeSaveEvent in interface IWorkbook
  - getNewSheetEvent
```
public Event<EventHandler<SheetEventArgs>> getNewSheetEvent()
```
    Occurs when a new sheet is created in the workbook.
    
    Specified by:
    
    getNewSheetEvent in interface IWorkbook
  - getOpenedEvent
```
public Event<EventHandler<EventArgs>> getOpenedEvent()
```
    Occurs when the workbook is opened.
    
    Specified by:
    
    getOpenedEvent in interface IWorkbook
  - getSheetActivateEvent
```
public Event<EventHandler<SheetEventArgs>> getSheetActivateEvent()
```
    Occurs when a sheet is active.
    
    Specified by:
    
    getSheetActivateEvent in interface IWorkbook
  - getSheetBeforeDeleteEvent
```
public Event<EventHandler<SheetEventArgs>> getSheetBeforeDeleteEvent()
```
    Occurs before a sheet is deleted.
    
    Specified by:
    
    getSheetBeforeDeleteEvent in interface IWorkbook
  - getSheetChangeEvent
```
public Event<EventHandler<RangeEventArgs>> getSheetChangeEvent()
```
    Occurs when something changes in the cells of a sheet.
    
    Specified by:
    
    getSheetChangeEvent in interface IWorkbook
  - getSheetDeactivateEvent
```
public Event<EventHandler<SheetEventArgs>> getSheetDeactivateEvent()
```
    Occurs when a sheet is deactivated.
    
    Specified by:
    
    getSheetDeactivateEvent in interface IWorkbook
  - getSheetSelectionChange
```
public Event<EventHandler<RangeEventArgs>> getSheetSelectionChange()
```
    Occurs when the selection changes on a sheet.
    
    Specified by:
    
    getSheetSelectionChange in interface IWorkbook
  - getPDFGraphics
```
public IGraphicsCore getPDFGraphics()
```
    Returns:
  - getData
```
public IWorkbookForShell getData()
```
    Returns:
  - getOptions
```
public IExcelOptions getOptions()
```
    Returns the IExcelOptions object that represents some settings to control workbook behavior.
    
    Specified by:
    
    getOptions in interface IWorkbook
  - getBuiltInDocumentProperties
```
public IBuiltInDocumentPropertyCollection getBuiltInDocumentProperties()
```
    Gets a collection that represents all the built-in document properties of the workbook.
    
    Specified by:
    
    getBuiltInDocumentProperties in interface IWorkbook
  - getCustomDocumentProperties
```
public ICustomDocumentPropertyCollection getCustomDocumentProperties()
```
    Gets a collection that represents all the custom document properties of the workbook.
    
    Specified by:
    
    getCustomDocumentProperties in interface IWorkbook
  - getCustomViews
```
public ICustomViews getCustomViews()
```
    Gets a collection that represents all the custom document properties of the workbook.
    
    Specified by:
    
    getCustomViews in interface IWorkbook
  - getWriteProtection
```
public WriteProtection getWriteProtection()
```
    Provides access to the workbook write protection options.
    
    Specified by:
    
    getWriteProtection in interface IWorkbook
  - getSignatures
```
public ISignatureSet getSignatures()
```
    Gets a collection of Signature objects that correspond to the digital signature attached to a document.
    
    Specified by:
    
    getSignatures in interface IWorkbook
  - getTagJsonSerializer
```
public static IJsonSerializer getTagJsonSerializer()
```
    Gets json serializer for custom type
    
    Returns:
  - setTagJsonSerializer
```
public static void setTagJsonSerializer(IJsonSerializer value)
```
    Sets json serializer for custom type in from/to json.
    
    Parameters:
    
    value -
  - getValueJsonSerializer
```
public static IJsonSerializer getValueJsonSerializer()
```
    Gets json serializer for custom type
    
    Returns:
  - setValueJsonSerializer
```
public static void setValueJsonSerializer(IJsonSerializer value)
```
    Sets json serializer for custom type in from/to json.
    
    Parameters:
    
    value -
  - getAutoParse
```
public boolean getAutoParse()
```
    Determines whether to parse automatically when setting range value to string value.
    
    Specified by:
    
    getAutoParse in interface IWorkbook
  - setAutoParse
```
public void setAutoParse(boolean value)
```
    Sets whether to automatically parse when setting a range value to a string value.
    
    Specified by:
    
    setAutoParse in interface IWorkbook
  - getAutoRoundValue
```
public boolean getAutoRoundValue()
```
    Determines whether to round the number to 15 significant figures when getting the value.
    
    Specified by:
    
    getAutoRoundValue in interface IWorkbook
  - setAutoRoundValue
```
public void setAutoRoundValue(boolean value)
```
    Sets whether to round the number to 15 significant figures when getting the value.
    
    Specified by:
    
    setAutoRoundValue in interface IWorkbook
  - getAutoCorrect
```
public IAutoCorrect getAutoCorrect()
```
    Returns:
  - getBookView
```
public IWorkbookView getBookView()
```
    Returns an object that represents the view settings of this workbook.
    
    Specified by:
    
    getBookView in interface IWorkbook
  - getProtectStructure
```
public boolean getProtectStructure()
```
    True if the order of the sheets in the workbook is protected. Read-only Boolean.
    
    Specified by:
    
    getProtectStructure in interface IWorkbook
  - getProtectWindows
```
public boolean getProtectWindows()
```
    True if the windows of the workbook are protected. Read-only Boolean.
    
    Specified by:
    
    getProtectWindows in interface IWorkbook
  - getReferenceStyle
```
public ReferenceStyle getReferenceStyle()
```
    Gets the reference style.
    
    Specified by:
    
    getReferenceStyle in interface IWorkbook
  - setReferenceStyle
```
public void setReferenceStyle(ReferenceStyle value)
```
    Sets the reference style.
    
    Specified by:
    
    setReferenceStyle in interface IWorkbook
  - getWorksheets
```
public IWorksheets getWorksheets()
```
    Gets a collection of worksheets contained in the workbook.
    
    Specified by:
    
    getWorksheets in interface IWorkbook
  - getActiveSheet
```
public IWorksheet getActiveSheet()
```
    Gets the active sheet.
    
    Specified by:
    
    getActiveSheet in interface IWorkbook
  - getTheme
```
public ITheme getTheme()
```
    Returns an instance of ITheme which provides access to the theme associated with a workbook.
    
    Specified by:
    
    getTheme in interface IWorkbook
  - setTheme
```
public void setTheme(ITheme value)
```
    Sets the theme applied to the current workbook.
    
    Specified by:
    
    setTheme in interface IWorkbook
  - getIconSets
```
public IIconSets getIconSets()
```
    Filters data in a workbook based on a cell icon from the IconSets collection.
    
    Specified by:
    
    getIconSets in interface IWorkbook
  - getDefaultTableStyle
```
public java.lang.String getDefaultTableStyle()
```
    Specifies the table style that is used as the default TableStyle.
    
    Specified by:
    
    getDefaultTableStyle in interface IWorkbook
  - setDefaultTableStyle
```
public void setDefaultTableStyle(java.lang.String value)
```
    Sets the table style name from the ITableStyleCollection collection that is used as the default TableStyle.
    
    Specified by:
    
    setDefaultTableStyle in interface IWorkbook
  - getCulture
```
public java.util.Locale getCulture()
```
    Gets the culture info of workbook, default is Locale.getDefault().
    
    Specified by:
    
    getCulture in interface IWorkbook
  - setCulture
```
public void setCulture(java.util.Locale value)
```
    Sets culture info for the workbook. Which influences the feature related culture.
    
    Specified by:
    
    setCulture in interface IWorkbook
  - getEnableCalculation
```
public boolean getEnableCalculation()
```
    Specifies whether the calculation engine is working.
    
    Specified by:
    
    getEnableCalculation in interface IWorkbook
  - setEnableCalculation
```
public void setEnableCalculation(boolean value)
```
    Sets whether the calculation engine is valid.
    
    Specified by:
    
    setEnableCalculation in interface IWorkbook
  - AddCustomFunction
```
public static void AddCustomFunction(CustomFunction func)
```
    Add custom function into the function set.
    
    Parameters:
    
    func - the custom function instance.
  - AddCustomFunction
```
public static void AddCustomFunction(CustomFunction func,
                                     boolean canOverride)
```
    Add custom function into the function set.
    
    Parameters:
    
    func - the custom function instance.
    
    canOverride - override the exist function.
  - getPivotCaches
```
public IPivotCaches getPivotCaches()
```
    Gets a PivotCaches collection that represents all the PivotTable caches in the specified workbook.
    
    Specified by:
    
    getPivotCaches in interface IWorkbook
  - getSlicerCaches
```
public ISlicerCaches getSlicerCaches()
```
    Gets the ISlicerCaches object associated with the workbook.
    
    Specified by:
    
    getSlicerCaches in interface IWorkbook
  - ToRGBColor
```
public Color ToRGBColor(ColorData color)
```
    Parameters:
    
    color -
    
    Returns:
  - getUsedFonts
```
public java.util.List<FontInfo> getUsedFonts()
```
    Gets all fonts information that are used on workbook.
    
    Specified by:
    
    getUsedFonts in interface IWorkbook
  - calculate
```
public void calculate()
```
    Calculates formulas in the workbook as needed.
    
    Specified by:
    
    calculate in interface IWorkbook
  - calculateFull
```
public void calculateFull()
```
    Forces to calculate all formulas of the workbook
  - dirty
```
public void dirty()
```
    Designates all the formulas of the workbook to be recalculated when the next calculation occurs.
    
    Specified by:
    
    dirty in interface IWorkbook
  - clear
```
public void clear()
```
    Clears data.
  - getStyles
```
public IStyleCollection getStyles()
```
    Provides access to the collection of cell styles in the current workbook.
    
    Specified by:
    
    getStyles in interface IWorkbook
  - getTableStyles
```
public ITableStyleCollection getTableStyles()
```
    Gets the table styles used in the current workbook.
    
    Specified by:
    
    getTableStyles in interface IWorkbook
  - getNames
```
public INames getNames()
```
    Returns the INames collection that represents all the names in the specified workbook (including all worksheet-specific names).
    
    Specified by:
    
    getNames in interface IWorkbook
  - getAuthor
```
public java.lang.String getAuthor()
```
    Gets the author.
    
    Specified by:
    
    getAuthor in interface IWorkbook
  - setAuthor
```
public void setAuthor(java.lang.String value)
```
    Sets the author.
    
    Specified by:
    
    setAuthor in interface IWorkbook
  - isEncryptedFile
```
public boolean isEncryptedFile(java.lang.String fileName)
```
    Specifies whether the file is password protected.
    
    Specified by:
    
    isEncryptedFile in interface IWorkbook
    
    Parameters:
    
    fileName - The file name.
  - isEncryptedFile
```
public boolean isEncryptedFile(java.io.InputStream fileStream)
```
    Specifies whether the file is password protected.
    
    Specified by:
    
    isEncryptedFile in interface IWorkbook
    
    Parameters:
    
    fileStream - The file stream.
  - toJson
```
public java.lang.String toJson()
```
    Generates a json string from the workbook.
    
    Specified by:
    
    toJson in interface IWorkbook
    
    Returns:
    
    the json string.
  - toJson
```
public java.lang.String toJson(SerializationOptions serializationOptions)
```
    Generates a json string from the workbook.
    
    Specified by:
    
    toJson in interface IWorkbook
    
    Parameters:
    
    serializationOptions - the SerializationOptions object.
    
    Returns:
    
    The json string
  - toJson
```
public void toJson(java.io.OutputStream stream)
```
    Generates a zipped json string from the workbook.
    
    Specified by:
    
    toJson in interface IWorkbook
    
    Parameters:
    
    stream - the output stream.
  - toJson
```
public void toJson(java.io.OutputStream stream,
                   SerializationOptions serializationOptions)
```
    Generates a json stream from a workbook.
    
    Specified by:
    
    toJson in interface IWorkbook
    
    Parameters:
    
    stream - the output stream.
    
    serializationOptions - the SerializationOptions object.
  - fromJson
```
public java.util.List<JsonError> fromJson(java.lang.String json)
```
    Generates a workbook from the json string.
    
    Specified by:
    
    fromJson in interface IWorkbook
    
    Parameters:
    
    json - the input json string.
    
    Returns:
    
    the errors in the json.
  - fromJson
```
public java.util.List<JsonError> fromJson(java.lang.String json,
                                          DeserializationOptions deserializationOptions)
```
    Generates a workbook from a json string.
    
    Specified by:
    
    fromJson in interface IWorkbook
    
    Parameters:
    
    json - the json.
    
    deserializationOptions - the DeserializationOptions object.
    
    Returns:
    
    the errors in the json.
  - fromJson
```
public java.util.List<JsonError> fromJson(java.io.InputStream stream)
```
    Generates a workbook from the json stream.
    
    Specified by:
    
    fromJson in interface IWorkbook
    
    Parameters:
    
    stream - the input stream.
    
    Returns:
    
    the errors in the json.
  - fromJson
```
public java.util.List<JsonError> fromJson(java.io.InputStream stream,
                                          DeserializationOptions deserializationOptions)
```
    Generates a workbook from a json stream.
    
    Specified by:
    
    fromJson in interface IWorkbook
    
    Parameters:
    
    stream - the stream
    
    deserializationOptions - the DeserializationOptions object.
    
    Returns:
    
    the errors in the json.
  - protect
```
public void protect()
```
    Protects a workbook so that it cannot be modified.
    
    Specified by:
    
    protect in interface IWorkbook
  - protect
```
public void protect(boolean structure)
```
    Protects a workbook so that it cannot be modified.
    
    Specified by:
    
    protect in interface IWorkbook
    
    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
```
public void protect(boolean structure,
                    boolean windows)
```
    Protects a workbook so that it cannot be modified.
    
    Specified by:
    
    protect in interface IWorkbook
    
    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
```
public void protect(java.lang.String password)
```
    Protects a workbook so that it cannot be modified.
    
    Specified by:
    
    protect in interface IWorkbook
    
    Parameters:
    
    password - Password to protect the workbook.
  - protect
```
public void protect(java.lang.String password,
                    boolean structure)
```
    Protects a workbook so that it cannot be modified.
    
    Specified by:
    
    protect in interface IWorkbook
    
    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
```
public void protect(java.lang.String password,
                    boolean structure,
                    boolean windows)
```
    Protects a workbook so that it cannot be modified.
    
    Specified by:
    
    protect in interface IWorkbook
    
    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
```
public void unprotect()
```
    Removes protection from the workbook.
    
    Specified by:
    
    unprotect in interface IWorkbook
  - unprotect
```
public void unprotect(java.lang.String password)
```
    Removes protection from the workbook.
    
    Specified by:
    
    unprotect in interface IWorkbook
    
    Parameters:
    
    password - Password to protect the workbook.
  - addDataSource
```
public void addDataSource(java.lang.String name,
                          java.lang.Object dataSource)
```
    Add data source for template
    
    Specified by:
    
    addDataSource in interface IWorkbook
    
    Parameters:
    
    name - : the alias name of the data source
    
    dataSource: - Can be object of ResultSet, Custom object and variable
  - processTemplate
```
public void processTemplate()
```
    Start to process the template
    
    Specified by:
    
    processTemplate in interface IWorkbook
  - getResetAdjacentRangeBorder
```
public boolean getResetAdjacentRangeBorder()
```
    Determines whether to reset adjacent range's border when setting border for a range. The default value of this property is true
    
    Specified by:
    
    getResetAdjacentRangeBorder in interface IWorkbook
  - setResetAdjacentRangeBorder
```
public 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
    
    Specified by:
    
    setResetAdjacentRangeBorder in interface IWorkbook
    
    Parameters:
    
    value -
  - SetLicenseKey
```
public static void SetLicenseKey(java.lang.String key)
```
    Sets license for all workbook instances.
    Important: For licenses of the Chinese market, use SetLicenseFile or set license in the GCEXCEL_JAVA_DEPLOY_LICENSE_V5 environment variable instead.
    
    Parameters:
    
    key - license key
  - SetLicenseFile
```
public static void SetLicenseFile(java.lang.String licenseFilePath)
```
    For licenses of the Chinese market, apply deployment license or unlimited dev license from file.
    This method shouldn't be called if your license was purchased from other markets.
    
    Parameters:
    
    licenseFilePath - The file that contains license key
  - GetStyle
```
public StyleData GetStyle(int styleID)
```
    Parameters:
    
    styleID -
    
    Returns:
  - getNumberFormatter
```
public IFormatter getNumberFormatter(java.lang.String formatCode)
```
    Parameters:
    
    formatCode -
    
    Returns:
  - SelectSheets
```
public final void SelectSheets(boolean replace,
                               java.lang.Iterable<java.lang.String> selection)
```
    Parameters:
    
    replace -
    
    selection -
  - getInternalHelper
```
public IInternalHelper getInternalHelper()
```
    Internal use
  - getCultureInfo
```
public ExcelCultureInfo getCultureInfo()
```
    Internal use
  - getMaxiumDigitWidth
```
public double getMaxiumDigitWidth(GraphicsType point)
```
    Parameters:
    
    point -
    
    Returns:
  - getGraphicsInfo
```
public final IGraphicsInfo getGraphicsInfo()
```
    Provides graphics information. If this property doesn't have value, the workbook will use built-in graphic information.
    
    Specified by:
    
    getGraphicsInfo in interface IWorkbook
  - setGraphicsInfo
```
public final void setGraphicsInfo(IGraphicsInfo value)
```
    Provides graphics information. If this property doesn't have value, the workbook will use built-in graphic information.
    
    Specified by:
    
    setGraphicsInfo in interface IWorkbook
  - getSelectedSheets
```
public final IWorksheets getSelectedSheets()
```
    Returns a IWorksheets collection that represents all the selected sheets in the specified workbook.
    
    Specified by:
    
    getSelectedSheets in interface IWorkbook
  - EnsureSelectedSheetsInitialized
```
public void EnsureSelectedSheetsInitialized()
```
  - createWorkbook
```
public Workbook createWorkbook()
```
    Returns:
  - getExcelLinkSources
```
public java.util.List<java.lang.String> getExcelLinkSources()
```
    Returns the names of the linked excel documents.
    
    Specified by:
    
    getExcelLinkSources in interface IWorkbook
  - updateExcelLinks
```
public void updateExcelLinks()
```
    Updates all the excel links.
    
    Specified by:
    
    updateExcelLinks in interface IWorkbook
  - updateExcelLink
```
public void updateExcelLink(java.lang.String name)
```
    Updates a excel link.
    
    Specified by:
    
    updateExcelLink in interface IWorkbook
  - updateExcelLink
```
public void updateExcelLink(java.lang.String name,
                            IWorkbook sourceWorkbook)
```
    Updates a excel link.
    
    Specified by:
    
    updateExcelLink in interface IWorkbook
  - getNames
```
public static java.lang.String[] getNames(java.lang.String fileName)
```
    Gets all sheet names and tables names that will be used as the parameter source of ImportData.
    If the name is a table name, the worksheet name is qualified before the table name, such as "Sheet1!Table1".
    
    Parameters:
    
    fileName - The path and name for the file.
  - getNames
```
public static java.lang.String[] getNames(java.io.InputStream fileStream)
```
    Gets all sheet names and tables names that will be used as the parameter source of ImportData.
    If the name is a table name, the worksheet name is qualified before the table name, such as "Sheet1!Table1".
    
    Parameters:
    
    fileStream - The fileStream of a workbook.
  - importData
```
public static java.lang.Object[][] importData(java.lang.String fileName,
                                              java.lang.String sourceName)
```
    Import all the data of the specified source of the file.
    
    Parameters:
    
    fileName - The path and name for the file.
    
    sourceName - The name of the source data. The source name could be:
    worksheet "Sheet1"
    table "Sheet1!Table1"
    range "Sheet1!A1:C5"
  - importData
```
public static java.lang.Object[][] importData(java.lang.String fileName,
                                              java.lang.String worksheetName,
                                              int row,
                                              int column,
                                              int rowCount,
                                              int columnCount)
```
    Import the data of a specified range from a file.
    
    Parameters:
    
    fileName - The path and name for the file.
    
    worksheetName - The name of the worksheet.
    
    row - The first row of the range.
    
    column - The first column of the range.
    
    rowCount - The count of the rows.
    
    columnCount - The count of the columns.
  - importData
```
public static java.lang.Object[][] importData(java.io.InputStream fileStream,
                                              java.lang.String sourceName)
```
    Import all the data of the specified source of the file.
    
    Parameters:
    
    fileStream - The fileStream of a workbook.
    
    sourceName - The name of the source data. The source name could be:
    worksheet "Sheet1"
    table "Sheet1!Table1"
    range "Sheet1!A1:C5"
  - importData
```
public static java.lang.Object[][] importData(java.io.InputStream fileStream,
                                              java.lang.String worksheetName,
                                              int row,
                                              int column,
                                              int rowCount,
                                              int columnCount)
```
    Import the data of a specified range from a fileStream.
    
    Parameters:
    
    fileStream - The fileStream of a workbook.
    
    worksheetName - The name of the worksheet.
    
    row - The first row of the range.
    
    column - The first column of the range.
    
    rowCount - The count of the rows.
    
    columnCount - The count of the columns.

Class Workbook

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FontsFolderPath

Constructor Detail

Workbook

Workbook

Method Detail

getAllowDynamicArray

setAllowDynamicArray

getDeferUpdateDirtyState

setDeferUpdateDirtyState

getName

setName

getFullName

getPath

setPath

open

open

open

open

open

open

open

open

open

save

save

save

save

save

save

save

save

getPdfGraphics

getAfterSaveEvent

getBeforeSaveEvent

getNewSheetEvent

getOpenedEvent

getSheetActivateEvent

getSheetBeforeDeleteEvent

getSheetChangeEvent

getSheetDeactivateEvent

getSheetSelectionChange

getPDFGraphics

getData

getOptions

getBuiltInDocumentProperties

getCustomDocumentProperties

getCustomViews

getWriteProtection

getSignatures

getTagJsonSerializer

setTagJsonSerializer

getValueJsonSerializer

setValueJsonSerializer

getAutoParse

setAutoParse

getAutoRoundValue

setAutoRoundValue

getAutoCorrect

getBookView

getProtectStructure

getProtectWindows

getReferenceStyle

setReferenceStyle

getWorksheets

getActiveSheet

getTheme

setTheme

getIconSets

getDefaultTableStyle

setDefaultTableStyle

getCulture

setCulture

getEnableCalculation

setEnableCalculation