Workbook (Aspose.Cells for Java)

java.lang.Object
- com.aspose.cells.Workbook

```
public class Workbook
extends java.lang.Object
```
Represents a root object to create an Excel spreadsheet.
Remarks
The Workbook class denotes an Excel spreadsheet. Each spreadsheet can contain multiple worksheets. The basic feature of the class is to open and save native excel files. The class has some advanced features like copying data from other Workbooks, combining two Workbooks, converting Excel to PDF, rendering Excel to image and protecting the Excel spreadsheet.
Example
The following example loads a Workbook from an Excel file named designer.xls and makes the horizontal and vertical scroll bars invisible. It then replaces two string values with an Integer value and string value respectively within the spreadsheet and finally save the workbook as Excel xlsx file.
```
 
         //Open a designer file
         String designerFile = "designer.xls";
         Workbook workbook = new Workbook(designerFile);
 
         //Set scroll bars
         workbook.getSettings().setHScrollBarVisible(false);
         workbook.getSettings().setVScrollBarVisible(false);
 
         //Replace the placeholder string with new values
         int newInt = 100;
         workbook.replace("OldInt", newInt);
 
         String newString = "Hello!";
         workbook.replace("OldString", newString);
         workbook.save("result.xlsx");
 
```

Constructor Summary

Constructors
Constructor and Description
`Workbook()` Initializes a new instance of the `Workbook` class.
`Workbook(java.io.InputStream stream)` Initializes a new instance of the `Workbook` class and open a stream.
`Workbook(java.io.InputStream stream, LoadOptions loadOptions)` Initializes a new instance of the `Workbook` class and open stream.
`Workbook(int fileFormatType)` Initializes a new instance of the `Workbook` class.
`Workbook(java.lang.String file)` Initializes a new instance of the `Workbook` class and open a file.
`Workbook(java.lang.String file, LoadOptions loadOptions)` Initializes a new instance of the `Workbook` class and open a file.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`acceptAllRevisions()` Accepts all tracked changes in the workbook.
`void`	`addDigitalSignature(DigitalSignatureCollection digitalSignatureCollection)` Adds digital signature to an OOXML spreadsheet file (Excel2007 and later).
`void`	`calculateFormula()` Calculates the result of formulas.
`void`	`calculateFormula(boolean ignoreError)` Calculates the result of formulas.
`void`	`calculateFormula(CalculationOptions options)` Calculating formulas in this workbook.
`void`	`changePalette(Color color, int index)` Changes the palette for the spreadsheet in the specified index.
`void`	`closeAccessCache(int opts)` Closes the session that uses caches to access data.
`void`	`combine(Workbook secondWorkbook)` Combines another Workbook object.
`void`	`copy(Workbook source)` Copies data from a source Workbook object.
`void`	`copy(Workbook source, CopyOptions copyOptions)` Copies another Workbook object.
`void`	`copyTheme(Workbook source)` Copies the theme from another workbook.
`Style`	`createBuiltinStyle(int type)` Creates built-in style by given type.
`CellsColor`	`createCellsColor()` Creates a `CellsColor` object.
`Style`	`createStyle()` Creates a new style.
`Style`	`createStyle(boolean cloneDefaultStyle)` Creates a new style.
`void`	`customTheme(java.lang.String themeName, Color[] colors)` Customs the theme.
`void`	`dispose()` Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
`void`	`exportXml(java.lang.String mapName, java.io.OutputStream stream)` Export XML data linked by the specified XML map.
`void`	`exportXml(java.lang.String mapName, java.lang.String path)` Export XML data linked by the specified XML map.
`java.lang.String`	`getAbsolutePath()` Gets the absolute path of the file.
`BuiltInDocumentPropertyCollection`	`getBuiltInDocumentProperties()` Returns a `DocumentProperty` collection that represents all the built-in document properties of the spreadsheet.
`CellsDataTableFactory`	`getCellsDataTableFactory()` Gets the factory for building ICellsDataTable from custom objects
`Color[]`	`getColors()` Returns colors in the palette for the spreadsheet.
`ContentTypePropertyCollection`	`getContentTypeProperties()` Gets the list of `ContentTypeProperty` objects in the workbook.
`int`	`getCountOfStylesInPool()` Gets number of the styles in the style pool.
`CustomDocumentPropertyCollection`	`getCustomDocumentProperties()` Returns a `DocumentProperty` collection that represents all the custom document properties of the spreadsheet.
`CustomXmlPartCollection`	`getCustomXmlParts()` Represents a Custom XML Data Storage Part (custom XML data within a package).
`ExternalConnectionCollection`	`getDataConnections()` Gets the `ExternalConnection` collection.
`DataMashup`	`getDataMashup()` Gets mashup data.
`DataModel`	`getDataModel()` Gets data model in the workbook.
`DataSorter`	`getDataSorter()` Gets a DataSorter object to sort data.
`Style`	`getDefaultStyle()` Gets the default `Style` object of the workbook.
`DigitalSignatureCollection`	`getDigitalSignature()` Gets digital signature from file.
`int`	`getFileFormat()` Gets the file format.
`java.lang.String`	`getFileName()` Gets the current file name.
`Font[]`	`getFonts()` Gets all fonts in the style pool.
`AbstractInterruptMonitor`	`getInterruptMonitor()` Gets the interrupt monitor.
`Color`	`getMatchingColor(Color rawColor)` Find best matching Color in current palette.
`Style`	`getNamedStyle(java.lang.String name)` Gets the named style in the style pool.
`java.lang.String`	`getRibbonXml()` Gets the XML file that defines the Ribbon UI.
`WorkbookSettings`	`getSettings()` Represents the workbook settings.
`Style`	`getStyleInPool(int index)` Gets the style in the style pool.
`java.lang.String`	`getTheme()` Gets the theme name.
`Color`	`getThemeColor(int type)` Gets theme color.
`VbaProject`	`getVbaProject()` Gets the `getVbaProject()` in a spreadsheet.
`WorksheetCollection`	`getWorksheets()` Gets the `WorksheetCollection` collection in the spreadsheet.
`boolean`	`hasCustomFunction()` Detects whether there is custom function used in this workbook, such as in cell's formula, in defined names...
`boolean`	`hasExernalLinks()` Deprecated. Use ExternalLinkCollection.Count property instead.
`boolean`	`hasMacro()` Indicates if this spreadsheet contains macro/VBA.
`boolean`	`hasRevisions()` Gets if the workbook has any tracked changes
`void`	`importXml(java.io.InputStream stream, java.lang.String sheetName, int row, int col)` Imports/Updates an XML data file into the workbook.
`void`	`importXml(java.lang.String url, java.lang.String sheetName, int row, int col)` Imports/Updates an XML data file into the workbook.
`boolean`	`isColorInPalette(Color color)` Checks if a color is in the palette for the spreadsheet.
`boolean`	`isDigitallySigned()` Indicates if this spreadsheet is digitally signed.
`boolean`	`isLicensed()` Indicates whether license is set.
`boolean`	`isWorkbookProtectedWithPassword()` Indicates whether structure or window is protected with password.
`void`	`mergeNamedStyles(Workbook source)` Merges named styles from the other Excel file.
`void`	`parseFormulas(boolean ignoreError)` Parses all formulas which have not been parsed when they were loaded from template file or set to a cell.
`void`	`protect(int protectionType, java.lang.String password)` Protects a workbook.
`void`	`protectSharedWorkbook(java.lang.String password)` Protects a shared workbook.
`void`	`refreshDynamicArrayFormulas(boolean calculate)` Refreshes dynamic array formulas(spill into new range of neighboring cells according to current data) Other formulas in the workbook will not be calculated recursively even if they were used by dynamic array formulas.
`void`	`refreshDynamicArrayFormulas(boolean calculate, CalculationOptions copts)` Refreshes dynamic array formulas(spill into new range of neighboring cells according to current data)
`void`	`removeDigitalSignature()` Removes digital signature from this spreadsheet.
`void`	`removeExternalLinks()` Deprecated. Use ExternalLinkCollection.Clear() method instead.
`void`	`removeMacro()` Removes VBA/macro from this spreadsheet.
`void`	`removePersonalInformation()` Removes personal information.
`void`	`removeUnusedStyles()` Remove all unused styles.
`int`	`replace(boolean boolValue, java.lang.Object newValue)` Replaces cells' values with new data.
`int`	`replace(int intValue, java.lang.Object newValue)` Replaces cells' values with new data.
`int`	`replace(java.lang.String placeHolder, double newValue)` Replaces a cell's value with a new double.
`int`	`replace(java.lang.String placeHolder, double[] newValues, boolean isVertical)` Replaces cells' values with a double array.
`int`	`replace(java.lang.String placeHolder, int newValue)` Replaces a cell's value with a new integer.
`int`	`replace(java.lang.String placeHolder, int[] newValues, boolean isVertical)` Replaces cells' values with an integer array.
`int`	`replace(java.lang.String placeHolder, java.lang.String newValue)` Replaces a cell's value with a new string.
`int`	`replace(java.lang.String placeHolder, java.lang.String[] newValues, boolean isVertical)` Replaces a cell's value with a new string array.
`int`	`replace(java.lang.String placeHolder, java.lang.String newValue, ReplaceOptions options)` Replaces a cell's value with a new string.
`void`	`save(java.io.OutputStream stream, int saveFormat)` Save the workbook to the stream.
`void`	`save(java.io.OutputStream stream, SaveOptions saveOptions)` Save the workbook to the stream.
`void`	`save(java.lang.String fileName)` Save the workbook to the disk.
`void`	`save(java.lang.String fileName, int saveFormat)` Saves the workbook to the disk.
`void`	`save(java.lang.String fileName, SaveOptions saveOptions)` Saves the workbook to the disk.
`void`	`setAbsolutePath(java.lang.String value)` Sets the absolute path of the file.
`void`	`setDefaultStyle(Style value)` Sets the default `Style` object of the workbook.
`void`	`setDigitalSignature(DigitalSignatureCollection digitalSignatureCollection)` Sets digital signature to an spreadsheet file (Excel2007 and later).
`void`	`setEncryptionOptions(int encryptionType, int keyLength)` Set Encryption Options.
`void`	`setFileFormat(int value)` Sets the file format.
`void`	`setFileName(java.lang.String value)` Sets the current file name.
`void`	`setInterruptMonitor(AbstractInterruptMonitor value)` Sets the interrupt monitor.
`void`	`setRibbonXml(java.lang.String value)` Sets the XML file that defines the Ribbon UI.
`void`	`setThemeColor(int type, Color color)` Sets the theme color
`void`	`startAccessCache(int opts)` Starts the session that uses caches to access data.
`void`	`unprotect(java.lang.String password)` Unprotects a workbook.
`void`	`unprotectSharedWorkbook(java.lang.String password)` Unprotects a shared workbook.
`void`	`updateCustomFunctionDefinition(CustomFunctionDefinition definition)` Updates definition of custom functions.
`void`	`updateLinkedDataSource(Workbook[] externalWorkbooks)` If this workbook contains external links to other data source, Aspose.Cells will attempt to retrieve the latest data from give sources.

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

Constructor Detail
- Workbook
```
public Workbook()
```
  Initializes a new instance of the Workbook class.
  Remarks
  The default file format type is Xlsx. If you want to create other types of files, please use Workbook(FileFormatType).
  Example
  The following code shows how to use the Workbook constructor to create and initialize a new instance of the class.
```
 
         Workbook workbook = new Workbook();
 
```
- Workbook
```
public Workbook(int fileFormatType)
```
  Initializes a new instance of the Workbook class.
  Remarks
  The default file format type is Excel97To2003.
  Example
  The following code shows how to use the Workbook constructor to create and initialize a new instance of the class with various file format type.
```
 
         Workbook workbook = new Workbook(FileFormatType.XLSX);
 
```
  Parameters:
  fileFormatType - FileFormatType. The new file format.
- Workbook
```
public Workbook(java.lang.String file)
```
  Initializes a new instance of the Workbook class and open a file.
  
  Parameters:
  file - The file name.
- Workbook
```
public Workbook(java.io.InputStream stream)
```
  Initializes a new instance of the Workbook class and open a stream.
  
  Parameters:
  stream - The stream.
- Workbook
```
public Workbook(java.lang.String file,
        LoadOptions loadOptions)
```
  Initializes a new instance of the Workbook class and open a file.
  
  Parameters:
  file - The file name.
  loadOptions - The load options
- Workbook
```
public Workbook(java.io.InputStream stream,
        LoadOptions loadOptions)
```
  Initializes a new instance of the Workbook class and open stream.
  
  Parameters:
  stream - The stream.
  loadOptions - The load options

Method Detail

getSettings
```
public WorkbookSettings getSettings()
```
Represents the workbook settings.

parseFormulas
```
public void parseFormulas(boolean ignoreError)
```
Parses all formulas which have not been parsed when they were loaded from template file or set to a cell.

Parameters:
ignoreError - Whether ignore error for invalid formula. For one invalid formula, if ignore error then this formula will be ignored and the process will continue to parse other formulas, otherwise exception will be thrown.

startAccessCache
```
public void startAccessCache(int opts)
```
Starts the session that uses caches to access data.
Remarks
If the cache of specified data access requires some data models in worksheet to be "read-only", then corresponding data models in every worksheet in this workbook will be taken as "read-only" and user should not change any of them.

After finishing the access to the data, closeAccessCache(int) should be invoked with same options to clear all caches and recover normal access mode.

Parameters:
opts - AccessCacheOptions. options of data access

closeAccessCache
```
public void closeAccessCache(int opts)
```
Closes the session that uses caches to access data.

Parameters:
opts - AccessCacheOptions. options of data access

save
```
public void save(java.lang.String fileName,
        int saveFormat)
```
Saves the workbook to the disk.

Parameters:
fileName - The file name.
saveFormat - SaveFormat. The save format type.

save
```
public void save(java.lang.String fileName)
```
Save the workbook to the disk.

Parameters:
fileName -

save
```
public void save(java.lang.String fileName,
        SaveOptions saveOptions)
```
Saves the workbook to the disk.

Parameters:
fileName - The file name.
saveOptions - The save options.

save
```
public void save(java.io.OutputStream stream,
        SaveOptions saveOptions)
```
Save the workbook to the stream.

Parameters:
stream - The file stream.
saveOptions - The save options.

save
```
public void save(java.io.OutputStream stream,
        int saveFormat)
```
Save the workbook to the stream.

Parameters:
stream - The file stream.
saveFormat - SaveFormat. The save file format type.

getWorksheets
```
public WorksheetCollection getWorksheets()
```
Gets the WorksheetCollection collection in the spreadsheet.

Returns:
WorksheetCollection collection

isLicensed
```
public boolean isLicensed()
```
Indicates whether license is set.

removeUnusedStyles
```
public void removeUnusedStyles()
```
Remove all unused styles.

createStyle
```
public Style createStyle()
```
Creates a new style.

Returns:
Returns a style object.

createStyle
```
public Style createStyle(boolean cloneDefaultStyle)
```
Creates a new style.

Parameters:
cloneDefaultStyle - Incidates whether clones the default style

Returns:
Returns a style object.

createBuiltinStyle
```
public Style createBuiltinStyle(int type)
```
Creates built-in style by given type.

Parameters:
type - BuiltinStyleType. The builtin style stype.

Returns:
Style object

createCellsColor
```
public CellsColor createCellsColor()
```
Creates a CellsColor object.

Returns:
Returns a CellsColor object.

replace

public int replace(java.lang.String placeHolder,
          java.lang.String newValue)

Replaces a cell's value with a new string.

Example

 
         Workbook workbook = new Workbook();
         //......
         workbook.replace("AnOldValue", "NewValue");

Parameters:: placeHolder - Cell placeholder; newValue - String value to replace

replace

public int replace(java.lang.String placeHolder,
          int newValue)

Replaces a cell's value with a new integer.

Example

 
         Workbook workbook = new Workbook();
         //......
         int newValue = 100;
         workbook.replace("AnOldValue", newValue);

Parameters:: placeHolder - Cell placeholder; newValue - Integer value to replace

replace

public int replace(java.lang.String placeHolder,
          double newValue)

Replaces a cell's value with a new double.

Example

 
         Workbook workbook = new Workbook();
         //......
         double newValue = 100.0;
         workbook.replace("AnOldValue", newValue);

Parameters:: placeHolder - Cell placeholder; newValue - Double value to replace

replace

public int replace(java.lang.String placeHolder,
          java.lang.String[] newValues,
          boolean isVertical)

Replaces a cell's value with a new string array.

Example

 
         Workbook workbook = new Workbook();
         //......
         String[] newValues = new String[]{"Tom", "Alice", "Jerry"};
         workbook.replace("AnOldValue", newValues, true);

Parameters:: placeHolder - Cell placeholder; newValues - String array to replace; isVertical - True - Vertical, False - Horizontal

replace

public int replace(java.lang.String placeHolder,
          int[] newValues,
          boolean isVertical)

Replaces cells' values with an integer array.

Example

 
         Workbook workbook = new Workbook();
         //......
         int[] newValues = new int[]{1, 2, 3};
         workbook.replace("AnOldValue", newValues, true);

Parameters:: placeHolder - Cell placeholder; newValues - Integer array to replace; isVertical - True - Vertical, False - Horizontal

replace

public int replace(java.lang.String placeHolder,
          double[] newValues,
          boolean isVertical)

Replaces cells' values with a double array.

Example

 
         Workbook workbook = new Workbook();
         //......
         double[] newValues = new double[]{1.23, 2.56, 3.14159};
         workbook.replace("AnOldValue", newValues, true);

Parameters:: placeHolder - Cell placeholder; newValues - Double array to replace; isVertical - True - Vertical, False - Horizontal

replace
```
public int replace(boolean boolValue,
          java.lang.Object newValue)
```
Replaces cells' values with new data.

Parameters:
boolValue - The boolean value to be replaced.
newValue - New value. Can be string, integer, double or DateTime value.

replace
```
public int replace(int intValue,
          java.lang.Object newValue)
```
Replaces cells' values with new data.

Parameters:
intValue - The integer value to be replaced.
newValue - New value. Can be string, integer, double or DateTime value.

replace
```
public int replace(java.lang.String placeHolder,
          java.lang.String newValue,
          ReplaceOptions options)
```
Replaces a cell's value with a new string.

Parameters:
placeHolder - Cell placeholder
newValue - String value to replace
options - The replace options

copy
```
public void copy(Workbook source,
        CopyOptions copyOptions)
```
Copies another Workbook object.
Remarks
It's very simple to clone an Excel file.

Parameters:
source - Source Workbook object.
copyOptions - The options of copying other workbook.

copy
```
public void copy(Workbook source)
```
Copies data from a source Workbook object.

Parameters:
source - Source Workbook object.

combine
```
public void combine(Workbook secondWorkbook)
```
Combines another Workbook object.
Remarks
Merge Excel, ODS , CSV and other files to one file.

Parameters:
secondWorkbook - Another Workbook object.

getColors
```
public Color[] getColors()
```
Returns colors in the palette for the spreadsheet.
Remarks
The palette has 56 entries, each represented by an RGB value.

getStyleInPool
```
public Style getStyleInPool(int index)
```
Gets the style in the style pool. All styles in the workbook will be gathered into a pool. There is only a simple reference index in the cells.
Remarks
If the returned style is changed, the style of all cells(which refers to this style) will be changed.

Parameters:
index - The index.

Returns:
The style in the pool corresponds to given index, may be null.

getCountOfStylesInPool
```
public int getCountOfStylesInPool()
```
Gets number of the styles in the style pool.

getFonts
```
public Font[] getFonts()
```
Gets all fonts in the style pool.

getNamedStyle
```
public Style getNamedStyle(java.lang.String name)
```
Gets the named style in the style pool.

Parameters:
name - name of the style

Returns:
named style, maybe null.

mergeNamedStyles
```
public void mergeNamedStyles(Workbook source)
```
Merges named styles from the other Excel file.

Parameters:
source - The other file

changePalette

public void changePalette(Color color,
                 int index)

Changes the palette for the spreadsheet in the specified index.

Remarks

The palette has 56 entries, each represented by an RGB value.

If you set a color which is not in the palette, it will not take effect.

So if you want to set a custom color, please change the palette at first.

The following is the standard color palette.

Color	Red	Green	Blue
Black	0	0	0
White	255	255	255
Red	255	0	0
Lime	0	255	0
Blue	0	0	255
Yellow	255	255	0
Magenta	255	0	255
Cyan	0	255	255
Maroon	128	0	0
Green	0	128	0
Navy	0	0	128
Olive	128	128	0
Purple	128	0	128
Teal	0	128	128
Silver	192	192	192
Gray	128	128	128
Color17	153	153	255
Color18	153	51	102
Color19	255	255	204
Color20	204	255	255
Color21	102	0	102
Color22	255	128	128
Color23	0	102	204
Color24	204	204	255
Color25	0	0	128
Color26	255	0	255
Color27	255	255	0
Color28	0	255	255
Color29	128	0	128
Color30	128	0	0
Color31	0	128	128
Color32	0	0	255
Color33	0	204	255
Color34	204	255	255
Color35	204	255	204
Color36	255	255	153
Color37	153	204	255
Color38	255	153	204
Color39	204	153	255
Color40	255	204	153
Color41	51	102	255
Color42	51	204	204
Color43	153	204	0
Color44	255	204	0
Color45	255	153	0
Color46	255	102	0
Color47	102	102	153
Color48	150	150	150
Color49	0	51	102
Color50	51	153	102
Color51	0	51	0
Color52	51	51	0
Color53	153	51	0
Color54	153	51	102
Color55	51	51	153
Color56	51	51	51

Parameters:: color - Color structure.; index - Palette index, 0 - 55.

isColorInPalette
```
public boolean isColorInPalette(Color color)
```
Checks if a color is in the palette for the spreadsheet.

Parameters:
color - Color structure.

Returns:
Returns true if this color is in the palette. Otherwise, returns false

calculateFormula
```
public void calculateFormula()
```
Calculates the result of formulas.
Remarks
For all supported formulas, please see the list at https://docs.aspose.com/display/cellsnet/Supported+Formula+Functions

calculateFormula
```
public void calculateFormula(boolean ignoreError)
```
Calculates the result of formulas.

Parameters:
ignoreError - Indicates if hide the error in calculating formulas. The error may be unsupported function, external links, etc.

calculateFormula
```
public void calculateFormula(CalculationOptions options)
```
Calculating formulas in this workbook.

Parameters:
options - Options for calculation

refreshDynamicArrayFormulas
```
public void refreshDynamicArrayFormulas(boolean calculate)
```
Refreshes dynamic array formulas(spill into new range of neighboring cells according to current data) Other formulas in the workbook will not be calculated recursively even if they were used by dynamic array formulas.

Parameters:
calculate - Whether calculates and updates cell values for those dynamic array formulas

refreshDynamicArrayFormulas
```
public void refreshDynamicArrayFormulas(boolean calculate,
                               CalculationOptions copts)
```
Refreshes dynamic array formulas(spill into new range of neighboring cells according to current data)
Remarks
For performance consideration, we do not refresh all dynamic array formulas automatically when the formula itself or the data it references to changed. So user need to call this method manually after those operations which may influence dynamic array formulas, such as importing/setting cell values, inserting/deleting rows/columns/ranges, ...etc.

For most formulas with functions, calculating the spill range also needs to calculating the formula, so in general true value for "calculate" flag is preferred. If the formula is simple, such as a range reference or array(for example "=C1:E5", "={1,2;3,4}", ...), simple function on a range or array(for example "=ABS(C1:E5)", "=1+{1,2;3,4}", ...), and all formulas will be calculated later(such as by calculateFormula(CalculationOptions)), then using false vlaue for "calculate" flag may avoid the duplicated calculation for the benefit of performance.

Parameters:
calculate - Whether calculates and updates cell values for those dynamic array formulas
copts - The options for calculating formulas

getDefaultStyle

public Style getDefaultStyle()

Gets the default Style object of the workbook.

Remarks

The DefaultStyle property is useful to implement a Style for the whole Workbook.

Example

The following code creates and instantiates a new Workbook and sets a default Style to it.

 
         Workbook workbook = new Workbook();
         Style defaultStyle = workbook.getDefaultStyle();
         defaultStyle.getFont().setName("Tahoma");
         workbook.setDefaultStyle(defaultStyle);

setDefaultStyle
```
public void setDefaultStyle(Style value)
```
Sets the default Style object of the workbook.
Remarks
The DefaultStyle property is useful to implement a Style for the whole Workbook.

getMatchingColor
```
public Color getMatchingColor(Color rawColor)
```
Find best matching Color in current palette.
Remarks
There are only 56 colors in the color palette in Excel 97-2003. If the color is not in the palette, the similar color will be set.

Parameters:
rawColor - Raw color.

Returns:
Best matching color.

isDigitallySigned
```
public boolean isDigitallySigned()
```
Indicates if this spreadsheet is digitally signed.

setEncryptionOptions
```
public void setEncryptionOptions(int encryptionType,
                        int keyLength)
```
Set Encryption Options.

Parameters:
encryptionType - EncryptionType. The encryption type.
keyLength - The key length.

protect
```
public void protect(int protectionType,
           java.lang.String password)
```
Protects a workbook.

Parameters:
protectionType - ProtectionType. Protection type.
password - Password to protect the workbook.

protectSharedWorkbook
```
public void protectSharedWorkbook(java.lang.String password)
```
Protects a shared workbook.

Parameters:
password - Password to protect the workbook.

unprotect
```
public void unprotect(java.lang.String password)
```
Unprotects a workbook.

Parameters:
password - Password to unprotect the workbook.

unprotectSharedWorkbook
```
public void unprotectSharedWorkbook(java.lang.String password)
```
Unprotects a shared workbook.

Parameters:
password - Password to unprotect the workbook.

isWorkbookProtectedWithPassword
```
public boolean isWorkbookProtectedWithPassword()
```
Indicates whether structure or window is protected with password.

removeMacro
```
public void removeMacro()
```
Removes VBA/macro from this spreadsheet.

getVbaProject
```
public VbaProject getVbaProject()
```
Gets the getVbaProject() in a spreadsheet.

removeDigitalSignature
```
public void removeDigitalSignature()
```
Removes digital signature from this spreadsheet.

acceptAllRevisions
```
public void acceptAllRevisions()
```
Accepts all tracked changes in the workbook.

hasMacro
```
public boolean hasMacro()
```
Indicates if this spreadsheet contains macro/VBA.

hasRevisions
```
public boolean hasRevisions()
```
Gets if the workbook has any tracked changes

getFileName
```
public java.lang.String getFileName()
```
Gets the current file name.
Remarks
If the file is opened by stream and there are some external formula references, please set the file name.

setFileName
```
public void setFileName(java.lang.String value)
```
Sets the current file name.
Remarks
If the file is opened by stream and there are some external formula references, please set the file name.

getCellsDataTableFactory
```
public CellsDataTableFactory getCellsDataTableFactory()
```
Gets the factory for building ICellsDataTable from custom objects

getDataSorter
```
public DataSorter getDataSorter()
```
Gets a DataSorter object to sort data.

removeExternalLinks
```
public void removeExternalLinks()
```
Deprecated. Use ExternalLinkCollection.Clear() method instead.

Removes all external links in the workbook.
Remarks
NOTE: This member is now obsolete. Instead, please use ExternalLinkCollection.Clear() method. This method will be removed 12 months later since December 2021. Aspose apologizes for any inconvenience you may have experienced.

getThemeColor
```
public Color getThemeColor(int type)
```
Gets theme color.

Parameters:
type - ThemeColorType. The theme color type.

Returns:
The theme color.

setThemeColor
```
public void setThemeColor(int type,
                 Color color)
```
Sets the theme color

Parameters:
type - ThemeColorType. The theme color type.
color - the theme color

getTheme
```
public java.lang.String getTheme()
```
Gets the theme name.

customTheme
```
public void customTheme(java.lang.String themeName,
               Color[] colors)
```
Customs the theme.
Remarks
The length of colors should be 12.

Array index Theme type

0 Backgournd1

1 Text1

2 Backgournd2

3 Text2

4 Accent1

5 Accent2

6 Accent3

7 Accent4

8 Accent5

9 Accent6

10 Hyperlink

11 Followed Hyperlink

Parameters:
themeName - The theme name
colors - The theme colors

Array index	Theme type
0	Backgournd1
1	Text1
2	Backgournd2
3	Text2
4	Accent1
5	Accent2
6	Accent3
7	Accent4
8	Accent5
9	Accent6
10	Hyperlink
11	Followed Hyperlink

copyTheme
```
public void copyTheme(Workbook source)
```
Copies the theme from another workbook.

Parameters:
source - Source workbook.

hasExernalLinks
```
public boolean hasExernalLinks()
```
Deprecated. Use ExternalLinkCollection.Count property instead.

Indicates whether this workbook contains external links to other data sources.
Remarks
NOTE: This member is now obsolete. Instead, please use ExternalLinkCollection.Count to check whether there are external links in this workbook. This method will be removed 12 months later since December 2021. Aspose apologizes for any inconvenience you may have experienced.

Returns:
Whether this workbook contains external links to other data sources.

updateCustomFunctionDefinition
```
public void updateCustomFunctionDefinition(CustomFunctionDefinition definition)
```
Updates definition of custom functions.
Remarks
This method can be used for some special scenarios. For example, if user needs some parameters of some custom functions be calculated in array mode, then user may provide their own definition with implemented CustomFunctionDefinition.getArrayModeParameters(String) for those functions. After the data of formulas being updated, those specified parameters will be calculated in array mode automatically when calculating corresponding custom functions.

Parameters:
definition - Special definition of custom functions for user's special requirement.

updateLinkedDataSource
```
public void updateLinkedDataSource(Workbook[] externalWorkbooks)
```
If this workbook contains external links to other data source, Aspose.Cells will attempt to retrieve the latest data from give sources.
Remarks
If corresponding external link cannot be found for one workbook, then this workbook will be ignored. So when you set a formula later with one new external link which you intend to make the ignored workbook be linked to it, the link cannot be performed until you call this this method again with those workbooks.

Parameters:
externalWorkbooks - Workbooks that will be used to update data of external links referenced by this workbook. The match of those workbooks with external links is determined by getFileName() and ExternalLink.getDataSource(). So please make sure getFileName() has been specified with the proper value for every workbook so they can be linked to corresponding external link.

getBuiltInDocumentProperties
```
public BuiltInDocumentPropertyCollection getBuiltInDocumentProperties()
```
Returns a DocumentProperty collection that represents all the built-in document properties of the spreadsheet.
Remarks
A new property cannot be added to built-in document properties list. You can only get a built-in property and change its value. The following is the built-in properties name list:
Title

Subject

Author

Keywords

Comments

Template

Last Author

Revision Number

Application Name

Last Print Date

Creation Date

Last Save Time

Total Editing Time

Number of Pages

Number of Words

Number of Characters

Security

Category

Format

Manager

Company

Number of Bytes

Number of Lines

Number of Paragraphs

Number of Slides

Number of Notes

Number of Hidden Slides

Number of Multimedia Clips

Example
```
 
         Workbook workbook = new Workbook();
         DocumentProperty doc = workbook.getBuiltInDocumentProperties().get("Author");
         doc.setValue("John Smith");
 
```

getCustomDocumentProperties

public CustomDocumentPropertyCollection getCustomDocumentProperties()

Returns a DocumentProperty collection that represents all the custom document properties of the spreadsheet.

Example

 
         Workbook excel = new Workbook();
         excel.getCustomDocumentProperties().add("Checked by", "Jane");

getFileFormat
```
public int getFileFormat()
```
Gets the file format.
See FileFormatType.

setFileFormat
```
public void setFileFormat(int value)
```
Sets the file format.
See FileFormatType.

hasCustomFunction
```
public boolean hasCustomFunction()
```
Detects whether there is custom function used in this workbook, such as in cell's formula, in defined names...

getInterruptMonitor

public AbstractInterruptMonitor getInterruptMonitor()

Gets the interrupt monitor.

setInterruptMonitor

public void setInterruptMonitor(AbstractInterruptMonitor value)

Sets the interrupt monitor.

getContentTypeProperties
```
public ContentTypePropertyCollection getContentTypeProperties()
```
Gets the list of ContentTypeProperty objects in the workbook.

getCustomXmlParts
```
public CustomXmlPartCollection getCustomXmlParts()
```
Represents a Custom XML Data Storage Part (custom XML data within a package).

getDataMashup
```
public DataMashup getDataMashup()
```
Gets mashup data.

getRibbonXml
```
public java.lang.String getRibbonXml()
```
Gets the XML file that defines the Ribbon UI.

setRibbonXml
```
public void setRibbonXml(java.lang.String value)
```
Sets the XML file that defines the Ribbon UI.

getAbsolutePath
```
public java.lang.String getAbsolutePath()
```
Gets the absolute path of the file.
Remarks
Only used for external links.

setAbsolutePath
```
public void setAbsolutePath(java.lang.String value)
```
Sets the absolute path of the file.
Remarks
Only used for external links.

getDataConnections

public ExternalConnectionCollection getDataConnections()

Gets the ExternalConnection collection.

importXml

public void importXml(java.lang.String url,
             java.lang.String sheetName,
             int row,
             int col)

Imports/Updates an XML data file into the workbook.

Example

The following code imports xml data into worksheet 'Sheet 1' at Cell A1.

 
         Workbook wb = new Workbook("Book1.xlsx");
 
         wb.importXml("xml.xml", "Sheet1", 0, 0);
 
         wb.save("output.xlsx");

Parameters:: url - the url/path of the xml file.; sheetName - the destination sheet name.; row - the destination row; col - the destination column

importXml
```
public void importXml(java.io.InputStream stream,
             java.lang.String sheetName,
             int row,
             int col)
```
Imports/Updates an XML data file into the workbook.

Parameters:
stream - the xml file stream.
sheetName - the destination sheet name.
row - the destination row.
col - the destination column.

exportXml

public void exportXml(java.lang.String mapName,
             java.lang.String path)

Export XML data linked by the specified XML map.

Example

The following code exported the data linked by the first XmlMap.

 
         Workbook wb = new Workbook("Book1.xlsx");
 
         //Make sure that the source xlsx file contains a XmlMap.
         XmlMap xmlMap = wb.getWorksheets().getXmlMaps().get(0);
 
         wb.exportXml(xmlMap.getName(), "output.xml");

Parameters:: mapName - name of the XML map that need to be exported; path - the export path

exportXml
```
public void exportXml(java.lang.String mapName,
             java.io.OutputStream stream)
```
Export XML data linked by the specified XML map.

Parameters:
mapName - name of the XML map that need to be exported
stream - the export stream

setDigitalSignature
```
public void setDigitalSignature(DigitalSignatureCollection digitalSignatureCollection)
```
Sets digital signature to an spreadsheet file (Excel2007 and later).
Remarks
Only support adding Xmldsig Digital Signature

Parameters:
digitalSignatureCollection -

addDigitalSignature
```
public void addDigitalSignature(DigitalSignatureCollection digitalSignatureCollection)
```
Adds digital signature to an OOXML spreadsheet file (Excel2007 and later).
Remarks
Only support adding Xmldsig Digital Signature to an OOXML spreadsheet file

Parameters:
digitalSignatureCollection -

getDigitalSignature

public DigitalSignatureCollection getDigitalSignature()

Gets digital signature from file.

removePersonalInformation
```
public void removePersonalInformation()
```
Removes personal information.

getDataModel
```
public DataModel getDataModel()
```
Gets data model in the workbook.

dispose
```
public void dispose()
```
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Class Workbook

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Workbook

Workbook

Workbook

Workbook

Workbook

Workbook

Method Detail

getSettings

parseFormulas

startAccessCache

closeAccessCache

save

save

save

save

save

getWorksheets

isLicensed

removeUnusedStyles

createStyle

createStyle

createBuiltinStyle

createCellsColor

replace

replace

replace

replace

replace

replace

replace

replace

replace

copy

copy

combine

getColors

getStyleInPool

getCountOfStylesInPool

getFonts

getNamedStyle

mergeNamedStyles

changePalette

isColorInPalette

calculateFormula

calculateFormula

calculateFormula

refreshDynamicArrayFormulas

refreshDynamicArrayFormulas

getDefaultStyle

setDefaultStyle

getMatchingColor

isDigitallySigned

setEncryptionOptions

protect

protectSharedWorkbook

unprotect

unprotectSharedWorkbook

isWorkbookProtectedWithPassword

removeMacro

getVbaProject

removeDigitalSignature

acceptAllRevisions

hasMacro

hasRevisions

getFileName

setFileName

getCellsDataTableFactory

getDataSorter

removeExternalLinks

getThemeColor

setThemeColor

getTheme

customTheme

copyTheme

hasExernalLinks