Interface IWorkbook

All Known Implementing Classes:: Workbook

public interface IWorkbook

Defines workbook-level APIs for working with spreadsheets.

This interface defines the workbook-level API for working with spreadsheets, including managing worksheets, accessing the active sheet, configuring workbook settings, handling workbook events, and performing operations such as calculation, opening, and saving.

The Workbook class is the known public implementation of this interface.


 IWorkbook workbook = new Workbook();
 workbook.getBuiltInDocumentProperties().setTitle("Quarterly Sales");
 workbook.getOptions().getFormulas().setEnableIterativeCalculation(true);
 workbook.getActiveSheet().getRange("A1").setValue("Revenue");
 IWorksheet worksheet = workbook.getWorksheets().get(0);

Method Summary

Modifier and Type

Method

Description

void

addDataSource(String name, Object dataSource)

Adds a named data source for template processing.

void

calculate()

Calculates formulas in the workbook as needed.

IWorkbook

clone()

Clones the current workbook and returns a new workbook instance.

void

convertBarcodeToPicture()

Converts calculated barcode formulas to pictures and places the pictures at their original positions.

void

convertBarcodeToPicture(ImageType imageType)

Converts calculated barcode formulas to pictures.

void

dirty()

Marks all formulas in the workbook as dirty so they are recalculated the next time calculation runs.

List<JsonError>

fromJson(InputStream stream)

Loads workbook content from a SpreadJS JSON (SSJSON) stream into this workbook.

List<JsonError>

fromJson(InputStream stream, DeserializationOptions deserializationOptions)

Loads workbook content from a SpreadJS JSON (SSJSON) stream into this workbook.

List<JsonError>

fromJson(String json)

Loads workbook content from a SpreadJS JSON (SSJSON) string into this workbook.

List<JsonError>

fromJson(String json, DeserializationOptions deserializationOptions)

Loads workbook content from a SpreadJS JSON (SSJSON) string into this workbook.

void

fromSjsJson(InputStream stream)

Loads a workbook from a JSON stream that contains SpreadJS .sjs file content.

void

fromSjsJson(InputStream stream, SjsOpenOptions openOptions)

Generates a workbook from a JSON stream containing .sjs file content.

void

fromSjsJson(String json)

Generates a workbook from a JSON string containing .sjs file content.

void

fromSjsJson(String json, SjsOpenOptions openOptions)

Generates a workbook from a JSON string containing SpreadJS .sjs file content, using the specified SjsOpenOptions.

IWorkbook

generateReport()

Processes the template and returns a new report workbook instance.

IWorkbook

generateReport(IWorksheet... worksheets)

Processes the template and returns a new report workbook that includes only the specified worksheets.

IWorksheet

getActiveSheet()

Gets the active worksheet in the workbook.

Event<EventHandler<EventArgs>>

getAfterSaveEvent()

Occurs after the workbook is saved.

boolean

getAllowDynamicArray()

Deprecated.
This method is obsolete.

String

getAuthor()

Gets the author of the workbook.

boolean

getAutoParse()

Gets whether string values are automatically parsed when assigned to a range.

boolean

getAutoRoundValue()

Gets whether numeric values are rounded to 15 significant digits when they are retrieved.

Event<EventHandler<EventArgs>>

getBeforeSaveEvent()

Occurs before the workbook is saved.

IWorkbookView

getBookView()

Gets the view settings of this workbook.

IBuiltInDocumentPropertyCollection

getBuiltInDocumentProperties()

Gets the collection of built-in document properties in the workbook.

Locale

getCulture()

Gets the culture information of the workbook.

ICustomDocumentPropertyCollection

getCustomDocumentProperties()

Gets the collection of custom document properties in the workbook.

ICustomViews

getCustomViews()

Gets the custom views of the workbook.

ICustomXmlPartCollection

getCustomXmlParts()

Gets the collection of Custom XML parts in the workbook.

String

getDefaultTableStyle()

Gets the table style name applied by default to newly created tables in the workbook.

boolean

getDeferUpdateDirtyState()

Gets whether updates to the dirty states of dependent formulas affected by cell value changes are deferred.

boolean

getEnableCalculation()

Gets whether the calculation engine is enabled for the workbook.

List<String>

getExcelLinkSources()

Gets the names of the linked Excel documents in the workbook.

String

getFullName()

Gets the workbook name, including its full path.

IGraphicsInfo

getGraphicsInfo()

Gets the graphics information used by the workbook.

IIconSets

getIconSets()

Gets the collection of icon sets available in the workbook.

String

getName()

Gets the name of the workbook.

INames

getNames()

Gets the collection of workbook-defined 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()

Gets the workbook options.

String

getPath()

Gets the path of the workbook file represented by this workbook object.

IPivotCaches

getPivotCaches()

Gets the IPivotCaches collection that contains all IPivotTable caches in the workbook.

boolean

getProtectStructure()

/ Gets a value indicating whether the workbook structure is protected.

boolean

getProtectWindows()

Gets a value indicating whether the workbook windows are protected.

ReferenceStyle

getReferenceStyle()

Gets the reference style used by the workbook.

boolean

getResetAdjacentRangeBorder()

Gets whether adjacent range borders are reset when a border is applied to a range.

IWorksheets

getSelectedSheets()

Gets the collection of selected worksheets in the workbook.

Event<EventHandler<SheetEventArgs>>

getSheetActivateEvent()

Occurs when a sheet is activated.

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.

ISheetTabs

getSheetTabs()

Gets the collection of sheet tabs contained in the workbook.

boolean

getShowPivotTableFieldList()

Gets a value indicating whether the PivotTable field list can be shown.

ISignatureSet

getSignatures()

Gets the collection of digital signatures attached to the workbook.

ISlicerCaches

getSlicerCaches()

Gets the ISlicerCaches collection associated with the workbook.

IStyleCollection

getStyles()

Gets the collection of styles in the current workbook.

ITableStyleCollection

getTableStyles()

Gets the ITableStyleCollection for the current workbook.

ITheme

getTheme()

Gets the theme associated with the workbook.

List<FontInfo>

getUsedFonts()

Gets all font information used in the workbook.

IWorksheets

getWorksheets()

Gets the IWorksheets collection that represents all worksheets in the workbook.

WriteProtection

getWriteProtection()

Gets the workbook write protection options.

boolean

isEncryptedFile(InputStream fileStream)

Determines whether the specified file stream is password protected.

boolean

isEncryptedFile(String fileName)

Determines whether the specified file is password protected.

void

open(InputStream fileStream)

Opens the specified Excel file stream.

void

open(InputStream fileStream, OpenFileFormat fileFormat)

Opens the specified format file stream.

void

open(InputStream fileStream, OpenOptionsBase options)

Opens the stream with specified options.

void

open(InputStream fileStream, String password)

Deprecated.
Use open(InputStream,OpenOptionsBase) instead.

void

open(String fileName)

Opens a workbook file.

List<JsonError>

open(String fileName, DeserializationOptions deserializationOptions)

Opens the specified JSON file.

void

open(String fileName, OpenFileFormat fileFormat)

Opens a file using the specified file format.

void

open(String fileName, OpenOptionsBase options)

Opens a file with the specified open options.

void

open(String fileName, String password)

Deprecated.
Use open(String,OpenOptionsBase) instead.

void

processTemplate()

Processes the workbook as a template by evaluating template fields and replacing them with data from the workbook's data sources.

void

processTemplate(CancellationToken cancellationToken)

Processes the workbook as a template and observes cancellation requests through the specified cancellation token.

void

protect()

Protects the workbook structure without a password.

void

protect(boolean structure)

Protects a workbook so that it cannot be modified.

void

protect(boolean structure, boolean windows)

Protects the workbook from modification based on the specified structure and window settings.

void

protect(String password)

Protects the workbook with a password so that it cannot be modified.

void

protect(String password, boolean structure)

Protects the workbook so that it cannot be modified.

void

protect(String password, boolean structure, boolean windows)

Protects a workbook so that it cannot be modified.

void

save(OutputStream outputStream)

Saves the workbook to the specified stream.

void

save(OutputStream fileStream, SaveFileFormat fileFormat)

Saves the workbook to the specified stream in the specified file format.

void

save(OutputStream fileStream, SaveOptionsBase options)

Saves the workbook to a stream with the specified save options.

void

save(OutputStream outputStream, String password)

Deprecated.
Use save(OutputStream,SaveOptionsBase) instead.

void

save(String fileName)

Saves the workbook to disk.

void

save(String fileName, SaveFileFormat fileFormat)

Saves the workbook to the specified file in the specified format.

void

save(String fileName, SaveOptionsBase options)

Saves the workbook to a file with the specified save options.

void

save(String fileName, String password)

Saves the workbook to the specified Excel file with a password.

void

setAllowDynamicArray(boolean value)

Deprecated.
Use IRange.setFormula2(String) to set dynamic array formulas.

void

setAuthor(String value)

Sets the author of the workbook.

void

setAutoParse(boolean value)

Sets whether string values are automatically parsed when assigned to a range.

void

setAutoRoundValue(boolean value)

Sets whether numeric values are rounded to 15 significant digits when they are retrieved.

void

setCulture(Locale value)

Sets the culture for the workbook.

void

setDefaultTableStyle(String value)

Sets the table style name applied by default to newly created tables in the workbook.

void

setDeferUpdateDirtyState(boolean value)

Sets whether updates to the dirty states of dependent formulas affected by cell value changes are deferred.

void

setEnableCalculation(boolean value)

Sets whether the calculation engine is enabled for the workbook.

void

setGraphicsInfo(IGraphicsInfo value)

Sets the graphics information used by the workbook.

void

setName(String name)

Sets the name of the workbook.

void

setPath(String path)

Sets the path of the workbook file represented by this workbook object.

void

setReferenceStyle(ReferenceStyle value)

Sets the reference style used for cell references in the workbook.

void

setResetAdjacentRangeBorder(boolean value)

Sets whether adjacent range borders are reset when a border is applied to a range.

void

setShowPivotTableFieldList(boolean value)

Sets a value indicating whether the PivotTable field list can be shown.

void

setTheme(ITheme value)

Sets the theme applied to the current workbook.

String

toJson()

Generates a JSON string from the workbook.

String

toJson(SerializationOptions serializationOptions)

Generates a JSON string from the workbook using the specified serialization options.

void

toJson(OutputStream stream)

Generates a JSON stream from the workbook.

void

toJson(OutputStream stream, SerializationOptions serializationOptions)

Serializes the workbook to JSON and writes the content to the specified output stream.

String

toSjsJson()

Generates a single JSON payload that represents the workbook in SpreadJS .sjs format.

String

toSjsJson(SjsSaveOptions options)

Generates a single JSON payload that represents the workbook in SpreadJS .sjs format, using the specified save options.

void

toSjsJson(OutputStream stream)

Writes a JSON string that combines all JSON parts of the SpreadJS .sjs content for this workbook to the specified stream.

void

toSjsJson(OutputStream stream, SjsSaveOptions options)

Integrates all JSON files in the SpreadJS .sjs format into a single string and writes it to the specified stream.

void

unprotect()

Removes protection from the workbook.

void

unprotect(String password)

Removes protection from the workbook.

void

updateExcelLink(String name)

Updates the Excel link with the specified name.

void

updateExcelLink(String name, IWorkbook sourceWorkbook)

Updates a specified Excel link by using the content from another workbook.

void

updateExcelLinks()

Updates all Excel links in the workbook.

void

waitForCalculationToFinish()

Waits for all calculations in the workbook to finish.

Method Details
- getAfterSaveEvent
  
  Event<EventHandler<EventArgs>> getAfterSaveEvent()
  Occurs after the workbook is saved.
  final ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); final boolean[] afterSaveHandled = {false}; Event<EventHandler<EventArgs>> afterSaveEvent = workbook.getAfterSaveEvent(); afterSaveEvent.addListener(new EventHandler<EventArgs>() { public void invoke(Object sender, EventArgs e) { afterSaveHandled[0] = outputStream.size() > 0; } }); workbook.getActiveSheet().getRange("A1").setValue("Ready"); workbook.save(outputStream); boolean saved = afterSaveHandled[0];
  Returns:
  
  The Event that occurs after the workbook is saved.
- getBeforeSaveEvent
  
  Event<EventHandler<EventArgs>> getBeforeSaveEvent()
  Occurs before the workbook is saved.
  final boolean[] beforeSaveHandled = {false}; Event<EventHandler<EventArgs>> beforeSaveEvent = workbook.getBeforeSaveEvent(); beforeSaveEvent.addListener(new EventHandler<EventArgs>() { public void invoke(Object sender, EventArgs e) { beforeSaveHandled[0] = "Ready".equals(workbook.getActiveSheet().getRange("A1").getValue()); } }); workbook.getActiveSheet().getRange("A1").setValue("Ready"); workbook.save(new ByteArrayOutputStream()); boolean saving = beforeSaveHandled[0];
  Returns:
  
  The Event that occurs before the workbook is saved.
- getNewSheetEvent
  
  Event<EventHandler<SheetEventArgs>> getNewSheetEvent()
  Occurs when a new sheet is created in the workbook.
  final IWorksheet[] sheetFromEvent = {null}; Event<EventHandler<SheetEventArgs>> newSheetEvent = workbook.getNewSheetEvent(); newSheetEvent.addListener(new EventHandler<SheetEventArgs>() { public void invoke(Object sender, SheetEventArgs e) { sheetFromEvent[0] = e.getSheet(); } }); workbook.getWorksheets().add(); IWorksheet newSheet = sheetFromEvent[0];
  Returns:
  
  The Event that occurs when a new sheet is created in the workbook.
- getOpenedEvent
  
  Event<EventHandler<EventArgs>> getOpenedEvent()
  Occurs when the workbook is opened.
  ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); workbook.getActiveSheet().getRange("A1").setValue("Opened"); workbook.save(outputStream); IWorkbook openedWorkbook = new Workbook(); final boolean[] openedHandled = {false}; Event<EventHandler<EventArgs>> openedEvent = openedWorkbook.getOpenedEvent(); openedEvent.addListener(new EventHandler<EventArgs>() { public void invoke(Object sender, EventArgs e) { openedHandled[0] = true; } }); openedWorkbook.open(new ByteArrayInputStream(outputStream.toByteArray())); boolean opened = openedHandled[0];
  Returns:
  
  The Event that occurs when the workbook is opened.
- getSheetActivateEvent
  
  Event<EventHandler<SheetEventArgs>> getSheetActivateEvent()
  Occurs when a sheet is activated.
  IWorksheet detailSheet = workbook.getWorksheets().add(); final IWorksheet[] sheetFromEvent = {null}; Event<EventHandler<SheetEventArgs>> sheetActivateEvent = workbook.getSheetActivateEvent(); sheetActivateEvent.addListener(new EventHandler<SheetEventArgs>() { public void invoke(Object sender, SheetEventArgs e) { sheetFromEvent[0] = e.getSheet(); } }); detailSheet.activate(); IWorksheet activeSheet = sheetFromEvent[0];
  Returns:
  
  The Event that occurs when a sheet is activated.
- getSheetBeforeDeleteEvent
  
  Event<EventHandler<SheetEventArgs>> getSheetBeforeDeleteEvent()
  Occurs before a sheet is deleted.
  IWorksheet sheetToDelete = workbook.getWorksheets().add(); final IWorksheet[] sheetFromEvent = {null}; Event<EventHandler<SheetEventArgs>> sheetBeforeDeleteEvent = workbook.getSheetBeforeDeleteEvent(); sheetBeforeDeleteEvent.addListener(new EventHandler<SheetEventArgs>() { public void invoke(Object sender, SheetEventArgs e) { sheetFromEvent[0] = e.getSheet(); } }); sheetToDelete.delete(); IWorksheet deletedSheet = sheetFromEvent[0];
  Returns:
  
  The Event that occurs before a sheet is deleted.
- getSheetChangeEvent
  
  Event<EventHandler<RangeEventArgs>> getSheetChangeEvent()
  Occurs when something changes in the cells of a sheet.
  final IRange[] rangeFromEvent = {null}; Event<EventHandler<RangeEventArgs>> sheetChangeEvent = workbook.getSheetChangeEvent(); sheetChangeEvent.addListener(new EventHandler<RangeEventArgs>() { public void invoke(Object sender, RangeEventArgs e) { rangeFromEvent[0] = e.getRange(); } }); workbook.getActiveSheet().getRange("A1").setValue("Updated"); IRange changedRange = rangeFromEvent[0];
  Returns:
  
  The Event that occurs when something changes in the cells of a sheet.
- getSheetDeactivateEvent
  
  Event<EventHandler<SheetEventArgs>> getSheetDeactivateEvent()
  Occurs when a sheet is deactivated.
  IWorksheet summarySheet = workbook.getWorksheets().add(); final IWorksheet[] sheetFromEvent = {null}; Event<EventHandler<SheetEventArgs>> sheetDeactivateEvent = workbook.getSheetDeactivateEvent(); sheetDeactivateEvent.addListener(new EventHandler<SheetEventArgs>() { public void invoke(Object sender, SheetEventArgs e) { sheetFromEvent[0] = e.getSheet(); } }); summarySheet.activate(); IWorksheet deactivatedSheet = sheetFromEvent[0];
  Returns:
  
  The Event that occurs when a sheet is deactivated.
- getSheetSelectionChange
  
  Event<EventHandler<RangeEventArgs>> getSheetSelectionChange()
  Occurs when the selection changes on a sheet.
  final IRange[] rangeFromEvent = {null}; Event<EventHandler<RangeEventArgs>> sheetSelectionChangeEvent = workbook.getSheetSelectionChange(); sheetSelectionChangeEvent.addListener(new EventHandler<RangeEventArgs>() { public void invoke(Object sender, RangeEventArgs e) { rangeFromEvent[0] = e.getRange(); } }); workbook.getActiveSheet().getRange("B2").select(); IRange selectedRange = rangeFromEvent[0];
  Returns:
  
  The Event that occurs when the selection changes on a sheet.
- getAllowDynamicArray
  
  @Deprecated boolean getAllowDynamicArray()
  
  Deprecated.
  This method is obsolete. Use IRange.setFormula2(String) to set a dynamic array formula.
  
  Gets whether dynamic array formulas are allowed for compatibility with IRange.setFormula(String).
  This method is obsolete. Dynamic array formulas should be defined by using IRange.setFormula2(String) instead. This property is retained for compatibility with earlier versions that enabled dynamic array behavior together with IRange.setFormula(String).
  
  Returns:
  
  true if dynamic array formulas are allowed for compatibility with IRange.setFormula(String); otherwise, false.
- setAllowDynamicArray
  
  @Deprecated void setAllowDynamicArray(boolean value)
  
  Deprecated.
  Use IRange.setFormula2(String) to set dynamic array formulas.
  
  Sets whether dynamic array formulas are allowed in the workbook.
  This method is deprecated. Use IRange.setFormula2(String) to assign dynamic array formulas directly instead of relying on this workbook-level setting.
  
  Parameters:
  
  value - true to allow dynamic array formulas in the workbook; otherwise, false.
- getDeferUpdateDirtyState
  
  boolean getDeferUpdateDirtyState()
  Gets whether updates to the dirty states of dependent formulas affected by cell value changes are deferred.
  When a cell value changes, dirty-state propagation normally runs immediately along the formula dependency chain. In scenarios with complex dependencies and frequent bulk value updates, this repeated propagation can introduce additional performance overhead.
  
  When this property is true, value changes are queued and the dirty states of dependent formulas are not updated immediately. When this property is set back to false, the workbook processes the queued changes and updates the affected dirty states in a batch. Therefore, true and false must be used in pairs: each time this property is set to true, it must be set back to false after bulk updates are complete. Otherwise, objects that rely on cached or delayed refresh results, such as charts, might still return stale values before the queued changes are processed.
  
  This property is intended for bulk cell value updates and can improve performance by reducing repeated dependency analysis and dirty-state propagation. It is not recommended when getValue and setValue operations are interleaved.
  
  worksheet.getRange("B1").setFormula("=SUM(A:A)"); workbook.setDeferUpdateDirtyState(true); boolean deferred; try { deferred = workbook.getDeferUpdateDirtyState(); for (int i = 0; i < 1000; i++) { worksheet.getRange(i, 0).setValue(i); } } finally { workbook.setDeferUpdateDirtyState(false); } Object value = worksheet.getRange("B1").getValue();
  Returns:
  
  true if updates to the dirty states of dependent formulas affected by cell value changes are deferred; otherwise, false.
- setDeferUpdateDirtyState
  
  void setDeferUpdateDirtyState(boolean value)
  Sets whether updates to the dirty states of dependent formulas affected by cell value changes are deferred.
  When a cell value changes, dirty-state propagation normally runs immediately along the formula dependency chain. In scenarios with complex dependencies and frequent bulk value updates, this repeated propagation can introduce additional performance overhead.
  
  When this property is true, value changes are queued and the dirty states of dependent formulas are not updated immediately. When this property is set back to false, the workbook processes the queued changes and updates the affected dirty states in a batch. Therefore, true and false must be used in pairs: each time this property is set to true, it must be set back to false after bulk updates are complete. Otherwise, objects that rely on cached or delayed refresh results, such as charts, might still return stale values before the queued changes are processed.
  
  This property is intended for bulk cell value updates and can improve performance by reducing repeated dependency analysis and dirty-state propagation. It is not recommended when getValue and setValue operations are interleaved.
  
  worksheet.getRange("B1").setFormula("=SUM(A:A)"); workbook.setDeferUpdateDirtyState(true); try { for (int i = 0; i < 1000; i++) { worksheet.getRange(i, 0).setValue(i); } } finally { workbook.setDeferUpdateDirtyState(false); } Object value = worksheet.getRange("B1").getValue();
  Parameters:
  
  value - true if updates to the dirty states of dependent formulas affected by cell value changes are deferred; otherwise, false.
- getName
  
  String getName()
  Gets the name of the workbook.
  This method returns the workbook name without the file path. To get the workbook name together with its path, use getFullName().
  
  String filePath = java.nio.file.Paths.get(System.getProperty("user.dir")).toString(); workbook.setPath(filePath); workbook.setName("QuarterlyReport.xlsx"); String name = workbook.getName();
  Returns:
  
  The name of the workbook.
- setName
  
  void setName(String name)
  Sets the name of the workbook.
  This method sets the workbook name without the file path. To get the workbook name together with its path, use getFullName().
  
  String filePath = java.nio.file.Paths.get(System.getProperty("user.dir")).toString(); workbook.setPath(filePath); workbook.setName("QuarterlyReport.xlsx");
  Parameters:
  
  name - The name of the workbook.
- getFullName
  
  String getFullName()
  Gets the workbook name, including its full path.
  This method returns the full workbook name composed from the workbook name and path information associated with this workbook.
  
  String filePath = java.nio.file.Paths.get(System.getProperty("user.dir")).toString(); workbook.setPath(filePath); workbook.setName("QuarterlyReport.xlsx"); String fullName = workbook.getFullName();
  Returns:
  
  The workbook name including its full path.
- getPath
  
  String getPath()
  Gets the path of the workbook file represented by this workbook object.
  Use this method to retrieve the path information associated with the current workbook. To get the workbook name together with its path, use getFullName().
  
  String directoryPath = java.nio.file.Paths.get(System.getProperty("user.dir"), "Documents").toString(); workbook.setPath(directoryPath); workbook.setName("Report.xlsx"); String path = workbook.getPath(); String fullName = workbook.getFullName();
  Returns:
  
  The path of the workbook file represented by this workbook object.
- setPath
  
  void setPath(String path)
  Sets the path of the workbook file represented by this workbook object.
  Use this method to set the path information associated with the current workbook. To set the workbook file name, use setName(String). To get the workbook name together with its path, use getFullName().
  
  String directoryPath = java.nio.file.Paths.get(System.getProperty("user.dir"), "Documents").toString(); workbook.setPath(directoryPath); workbook.setName("Report.xlsx"); String fullName = workbook.getFullName();
  Parameters:
  
  path - The path of the workbook file represented by this workbook object.
- getSelectedSheets
  
  IWorksheets getSelectedSheets()
  Gets the collection of selected worksheets in the workbook.
  The returned IWorksheets object represents all worksheets that are currently selected.
  
  IWorksheet sheet2 = workbook.getWorksheets().add(); workbook.getWorksheets().get(new String[] {worksheet.getName(), sheet2.getName()}).select(); IWorksheets selectedSheets = workbook.getSelectedSheets();
  Returns:
  
  An IWorksheets collection that represents all selected worksheets in the workbook.
- getOptions
  
  IExcelOptions getOptions()
  Gets the workbook options.
  Returns the IExcelOptions object that contains settings used to control workbook behavior, such as formula-related options and data-related options.
  
  IExcelOptions options = workbook.getOptions(); workbook.getActiveSheet().getRange("A1").setFormula("SUM(1, 2)"); options.getFormulas().setCalculationMode(CalculationMode.Manual); workbook.save("path/to/manual-mode.xlsx");
  Returns:
  
  The IExcelOptions object that contains workbook option settings.
- getResetAdjacentRangeBorder
  
  boolean getResetAdjacentRangeBorder()
  Gets whether adjacent range borders are reset when a border is applied to a range.
  The default value is true.
  
  worksheet.getRange("D2:D3").getBorders().get(BordersIndex.EdgeLeft).setLineStyle(BorderLineStyle.Thick); workbook.setResetAdjacentRangeBorder(true); boolean resetAdjacentBorder = workbook.getResetAdjacentRangeBorder(); worksheet.getRange("B2:C3").getBorders().get(BordersIndex.EdgeRight).setLineStyle(BorderLineStyle.Thin); BorderLineStyle adjacentLeftBorder = worksheet.getRange("D2:D3").getBorders().get(BordersIndex.EdgeLeft).getLineStyle();
  Returns:
  
  true if borders of adjacent ranges are reset when setting a border for a range; otherwise, false.
- setResetAdjacentRangeBorder
  
  void setResetAdjacentRangeBorder(boolean value)
  Sets whether adjacent range borders are reset when a border is applied to a range.
  The default value is true.
  
  worksheet.getRange("D2:D3").getBorders().get(BordersIndex.EdgeLeft).setLineStyle(BorderLineStyle.Thick); workbook.setResetAdjacentRangeBorder(true); worksheet.getRange("B2:C3").getBorders().get(BordersIndex.EdgeRight).setLineStyle(BorderLineStyle.Thin); BorderLineStyle adjacentLeftBorder = worksheet.getRange("D2:D3").getBorders().get(BordersIndex.EdgeLeft).getLineStyle();
  Parameters:
  
  value - true if borders of adjacent ranges are reset when setting a border for a range; otherwise, false.
- getAutoParse
  
  boolean getAutoParse()
  Gets whether string values are automatically parsed when assigned to a range.
  When this property is true, string values assigned with IRange.setValue(Object) may be interpreted as numbers, date/time values, boolean values, error values, or empty cell values instead of being kept as plain text.
  
  workbook.setAutoParse(true); worksheet.getRange("A1").setValue("123"); Object value = worksheet.getRange("A1").getValue(); boolean autoParse = workbook.getAutoParse();
  Returns:
  
  true if string values are automatically parsed when assigned to a range; otherwise, false.
- setAutoParse
  
  void setAutoParse(boolean value)
  Sets whether string values are automatically parsed when assigned to a range.
  When this property is true, string values assigned with IRange.setValue(Object) may be interpreted as numbers, date/time values, boolean values, error values, or empty cell values instead of being kept as plain text.
  
  workbook.setAutoParse(true); worksheet.getRange("A1").setValue("123"); Object value = worksheet.getRange("A1").getValue();
  Parameters:
  
  value - true if string values are automatically parsed when assigned to a range; otherwise, false.
- getAutoRoundValue
  
  boolean getAutoRoundValue()
  Gets whether numeric values are rounded to 15 significant digits when they are retrieved.
  Use this property to determine whether the workbook applies automatic rounding when reading numeric cell values.
  
  worksheet.getRange("A1").setValue(1.2345678901234567d); workbook.setAutoRoundValue(true); boolean autoRoundValue = workbook.getAutoRoundValue(); Object value = worksheet.getRange("A1").getValue();
  Returns:
  
  true if numeric values are rounded to 15 significant digits when retrieved; otherwise, false.
- setAutoRoundValue
  
  void setAutoRoundValue(boolean value)
  Sets whether numeric values are rounded to 15 significant digits when they are retrieved.
  Use this property to set whether the workbook applies automatic rounding when reading numeric cell values.
  
  worksheet.getRange("A1").setValue(1.2345678901234567d); workbook.setAutoRoundValue(true); Object value = worksheet.getRange("A1").getValue();
  Parameters:
  
  value - true if numeric values are rounded to 15 significant digits when retrieved; otherwise, false.
- getBookView
  
  IWorkbookView getBookView()
  Gets the view settings of this workbook.
  Use the returned IWorkbookView object to configure workbook-level display options such as workbook tabs, scroll bars, and tab ratio.
  
  IWorkbookView bookView = workbook.getBookView(); bookView.setDisplayWorkbookTabs(true); bookView.setDisplayVerticalScrollBar(false);
  Returns:
  
  The IWorkbookView object that represents the view settings of this workbook.
- getProtectStructure
  
  boolean getProtectStructure()
  / Gets a value indicating whether the workbook structure is protected.
  When the workbook structure is protected, the order of worksheets cannot be changed until the protection is removed by using unprotect().
  
  worksheet.getRange("A1").setValue("Quarterly Report"); workbook.protect(true); boolean protectStructure = workbook.getProtectStructure();
  Returns:
  
  true if the order of the sheets in the workbook is protected; otherwise, false.
- getProtectWindows
  
  boolean getProtectWindows()
  Gets a value indicating whether the workbook windows are protected.
  This property reflects the workbook window protection state set by protect(boolean,boolean). When workbook windows are protected, the window layout cannot be modified until the protection is removed.
  
  worksheet.getRange("A1").setValue("Quarterly Report"); workbook.protect(true, true); boolean protectWindows = workbook.getProtectWindows();
  Returns:
  
  true if the workbook windows are protected; otherwise, false.
- getSignatures
  
  ISignatureSet getSignatures()
  Gets the collection of digital signatures attached to the workbook.
  The returned ISignatureSet provides access to the signatures in the document, including signature lines and non-visible signatures.
  
  workbook.getSignatures().addSignatureLine(worksheet, 100.0, 50.0); ISignatureSet signatures = workbook.getSignatures(); ISignature signature = signatures.get(0);
  Returns:
  
  The collection of digital signatures attached to the workbook.
- getBuiltInDocumentProperties
  
  IBuiltInDocumentPropertyCollection getBuiltInDocumentProperties()
  Gets the collection of built-in document properties in the workbook.
  The returned IBuiltInDocumentPropertyCollection provides access to built-in metadata such as author, title, subject, company, and other standard document properties.
  
  workbook.getBuiltInDocumentProperties().setAuthor("Author"); workbook.getBuiltInDocumentProperties().setCompany("Example"); IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
  Returns:
  
  The collection that represents all built-in document properties of the workbook.
- getCustomDocumentProperties
  
  ICustomDocumentPropertyCollection getCustomDocumentProperties()
  Gets the collection of custom document properties in the workbook.
  Use the returned ICustomDocumentPropertyCollection to add, remove, and retrieve workbook metadata defined by the application, such as string, numeric, Boolean, date, or linked-content properties.
  
  worksheet.getRange("A1").setValue("Quarterly Report"); workbook.getNames().add("ReportTitle", "=Sheet1!$A$1"); ICustomDocumentPropertyCollection properties = workbook.getCustomDocumentProperties(); properties.add("Department", "Finance"); properties.addLinkToContent("TitleProperty", "ReportTitle");
  Returns:
  
  The collection that represents all custom document properties of the workbook.
- getCustomXmlParts
  
  ICustomXmlPartCollection getCustomXmlParts()
  Gets the collection of Custom XML parts in the workbook.
  Use the returned ICustomXmlPartCollection to add, retrieve, enumerate, or remove workbook-level Custom XML parts. Custom XML parts are stored in the OpenXML package as raw XML payloads and are preserved when saving to OpenXML workbook formats such as XLSX and XLSM.
  
  This API stores and returns the XML bytes only. It does not validate the XML against a schema.
  
  Workbook workbook = new Workbook(); ICustomXmlPart customXmlPart = workbook.getCustomXmlParts().add(); customXmlPart.setData("<payload><customer id=\"42\"/></payload>" .getBytes(java.nio.charset.StandardCharsets.UTF_8)); String customXmlPartId = customXmlPart.getId(); workbook.save("customXmlWorkbook.xlsm"); Workbook uploadedWorkbook = new Workbook(); uploadedWorkbook.open("customXmlWorkbook.xlsm"); ICustomXmlPart uploadedPart = uploadedWorkbook.getCustomXmlParts().get(customXmlPartId); byte[] uploadedXmlData = uploadedPart.getData();
  Returns:
  
  The collection that represents all Custom XML parts in the workbook.
- getCustomViews
  
  ICustomViews getCustomViews()
  Gets the custom views of the workbook.
  The returned ICustomViews collection contains the custom views stored in the workbook. Each custom view is represented by an ICustomView object and stores the view state of all worksheets in the current workbook.
  
  worksheet.getRange("A1").setValue("Name"); ICustomViews customViews = workbook.getCustomViews(); customViews.add("Normal", true, true); ICustomView customView = workbook.getCustomViews().get("Normal"); customView.show();
  Returns:
  
  The ICustomViews collection that contains the workbook's custom views.
- getWriteProtection
  
  WriteProtection getWriteProtection()
  Gets the workbook write protection options.
  The returned WriteProtection object provides access to settings that control write protection behavior when the workbook is opened in an Excel application, such as recommending read-only mode and setting a password required for modification.
  
  WriteProtection protection = workbook.getWriteProtection(); protection.setWriteReservedBy("User"); protection.setReadOnlyRecommended(true); String password = getPasswordFromSecureSource(); protection.setWritePassword(password); boolean writeReserved = protection.getWriteReserved(); boolean passwordMatches = protection.validatePassword(password);
  Returns:
  
  The WriteProtection object for the workbook.
- getEnableCalculation
  
  boolean getEnableCalculation()
  Gets whether the calculation engine is enabled for the workbook.
  When this property is false, formulas in the current workbook are no longer recalculated. If formula results are retrieved while calculation is disabled, the last calculated results from before calculation was disabled are returned.
  
  This property is intended for large batch updates of values or formulas when updated calculation results are not needed until the batch is complete. Set this property to false before the batch to improve performance, and set it back to true when you need to calculate the workbook again.
  
  worksheet.getRange("A1").setValue(1); worksheet.getRange("B1").setFormula("=A1*2"); workbook.calculate(); workbook.setEnableCalculation(false); worksheet.getRange("A1").setValue(10); workbook.calculate(); Object value = worksheet.getRange("B1").getValue(); boolean enabled = workbook.getEnableCalculation();
  Returns:
  
  true if the calculation engine is enabled; otherwise, false.
- setEnableCalculation
  
  void setEnableCalculation(boolean value)
  Sets whether the calculation engine is enabled for the workbook.
  When this property is false, formulas in the current workbook are no longer recalculated. If formula results are retrieved while calculation is disabled, the last calculated results from before calculation was disabled are returned.
  
  This property is intended for large batch updates of values or formulas when updated calculation results are not needed until the batch is complete. Set this property to false before the batch to improve performance, and set it back to true when you need to calculate the workbook again.
  
  worksheet.getRange("A1").setValue(1); worksheet.getRange("B1").setFormula("=A1*2"); workbook.calculate(); workbook.setEnableCalculation(false); worksheet.getRange("A1").setValue(10); workbook.calculate(); Object value = worksheet.getRange("B1").getValue();
  Parameters:
  
  value - true if the calculation engine is enabled; otherwise, false.
- getCulture
  
  Locale getCulture()
  Gets the culture information of the workbook.
  The returned culture affects culture-related features such as localized formatting and formula behavior. If no culture has been explicitly set, the default value is Locale.getDefault().
  
  workbook.setCulture(Locale.US); worksheet.getRange("A1").setValue(43245.5922); worksheet.getRange("A1").setNumberFormat("[$-x-sysdate]dddd, mmmm dd, yyyy"); String text = worksheet.getRange("A1").getText(); Locale culture = workbook.getCulture();
  Returns:
  
  The culture information of the workbook.
- setCulture
  
  void setCulture(Locale value)
  Sets the culture for the workbook.
  This setting affects culture-sensitive features such as localized formulas and culture-dependent date and time formats.
  
  The locale should include both language and country or region, such as Locale.CHINA, Locale.KOREA, or Locale.US.
  
  workbook.setCulture(Locale.US); worksheet.getRange("A1").setValue(43245.5922); worksheet.getRange("A1").setNumberFormat("[$-x-sysdate]dddd, mmmm dd, yyyy"); String text = worksheet.getRange("A1").getText();
  Parameters:
  
  value - The locale to apply to the workbook. Use a locale that includes both language and country or region.
  
  API Note:
  
  The culture is init-only. It must be set in the initialization code of the workbook instance.
- getDefaultTableStyle
  
  String getDefaultTableStyle()
  Gets the table style name applied by default to newly created tables in the workbook.
  Use this method to retrieve the table style name that new tables use by default in the workbook.
  
  workbook.setDefaultTableStyle("TableStyleMedium3"); worksheet.getRange("A1:B2").setValue(new Object[][]{ {"Product", "Sales"}, {"Tablet", 1200} }); ITable table = worksheet.getTables().add(worksheet.getRange("A1:B2"), true); ITableStyle tableStyle = table.getTableStyle(); String tableStyleName = tableStyle.getName(); String defaultTableStyle = workbook.getDefaultTableStyle();
  Returns:
  
  The name of the default table style.
- setDefaultTableStyle
  
  void setDefaultTableStyle(String value)
  Sets the table style name applied by default to newly created tables in the workbook.
  Use this method to set the table style name that new tables use by default in the workbook.
  
  workbook.setDefaultTableStyle("TableStyleMedium3"); worksheet.getRange("A1:B2").setValue(new Object[][]{ {"Product", "Sales"}, {"Tablet", 1200} }); ITable table = worksheet.getTables().add(worksheet.getRange("A1:B2"), true); ITableStyle tableStyle = table.getTableStyle(); String tableStyleName = tableStyle.getName();
  Parameters:
  
  value - The name of the default table style.
- getNames
  
  INames getNames()
  Gets the collection of workbook-defined names.
  Use the returned INames collection to add, retrieve, and manage names defined at the workbook level.
  
  workbook.getNames().add("SalesTotal", "=Sheet1!$A$1:$A$3"); INames names = workbook.getNames(); IName name = names.get("SalesTotal");
  Returns:
  
  The INames collection that represents the workbook-specified names.
- getAuthor
  
  String getAuthor()
  Gets the author of the workbook.
  Use setAuthor(String) to assign the author metadata before retrieving it.
  
  workbook.setAuthor("Author"); String author = workbook.getAuthor();
  Returns:
  
  The author of the workbook.
- setAuthor
  
  void setAuthor(String value)
  Sets the author of the workbook.
  workbook.setAuthor("Author");
  Parameters:
  
  value - The author of the workbook.
- getPivotCaches
  
  IPivotCaches getPivotCaches()
  Gets the IPivotCaches collection that contains all IPivotTable caches in the workbook.
  Use this method to access existing PivotTable caches or create a new cache from source data before adding a PivotTable.
  
  worksheet.getRange("A1:B4").setValue(new Object[][] { {"Product", "Sales"}, {"Apple", 100}, {"Pear", 200}, {"Orange", 150} }); IPivotCaches pivotCaches = workbook.getPivotCaches(); IPivotCache pivotCache = pivotCaches.create(worksheet.getRange("A1:B4"));
  Returns:
  
  The IPivotCaches collection for the workbook.
- getReferenceStyle
  
  ReferenceStyle getReferenceStyle()
  Gets the reference style used by the workbook.
  The reference style determines how cell references are represented in formulas and addresses, such as ReferenceStyle.A1 style references like A1 or ReferenceStyle.R1C1 style references like R1C1.
  
  worksheet.getRange("B1").setValue(100); worksheet.getRange("C1").setValue(200); workbook.setReferenceStyle(ReferenceStyle.R1C1); ReferenceStyle style = workbook.getReferenceStyle(); worksheet.getRange("A1").setFormula("=RC[1]+RC[2]");
  Returns:
  
  The current reference style. The returned value is ReferenceStyle.A1 or ReferenceStyle.R1C1.
- setReferenceStyle
  
  void setReferenceStyle(ReferenceStyle value)
  Sets the reference style used for cell references in the workbook.
  Use this method to switch between ReferenceStyle.A1 references such as A1 and ReferenceStyle.R1C1 references such as R1C1 or R[0]C[1].
  
  worksheet.getRange("B1").setValue(100); worksheet.getRange("C1").setValue(200); workbook.setReferenceStyle(ReferenceStyle.R1C1); worksheet.getRange("A1").setFormula("=RC[1]+RC[2]");
  Parameters:
  
  value - The reference style to use for cell references. Use ReferenceStyle.A1 for A1-style references or ReferenceStyle.R1C1 for R1C1-style references. If null, A1-style references are used.
- getStyles
  
  IStyleCollection getStyles()
  Gets the collection of styles in the current workbook.
  This method returns an IStyleCollection that provides access to the built-in and custom styles available in the workbook.
  
  IStyleCollection styles = workbook.getStyles(); IStyle style = styles.add("DataStyle"); style.getFont().setBold(true); worksheet.getRange("A1").setStyle(style);
  Returns:
  
  The IStyleCollection that represents all styles in the current workbook.
- getTableStyles
  
  ITableStyleCollection getTableStyles()
  Gets the ITableStyleCollection for the current workbook.
  This collection contains the table styles available in the workbook, including built-in styles and any custom table styles added to it.
  
  ITableStyleCollection tableStyles = workbook.getTableStyles(); ITableStyle customStyle = tableStyles.add("SalesStyle"); ITableStyle builtInStyle = tableStyles.get("TableStyleMedium3"); worksheet.getTables().add(worksheet.getRange("A1:B3"), true).setTableStyle(builtInStyle);
  Returns:
  
  The ITableStyleCollection that represents the table styles in the current workbook.
- getTheme
  
  ITheme getTheme()
  Gets the theme associated with the workbook.
  Use this method to access the current ITheme applied to the workbook. The returned theme can be inspected or reused with setTheme(ITheme).
  
  ITheme theme = Themes.GetFacet(); workbook.setTheme(theme); String themeName = theme.getName(); ITheme currentTheme = workbook.getTheme();
  Returns:
  
  The ITheme instance associated with the workbook.
- setTheme
  
  void setTheme(ITheme value)
  Sets the theme applied to the current workbook.
  The specified theme becomes the workbook's active theme and is used to update theme-based formatting in the workbook.
  
  ITheme theme = Themes.GetFacet(); workbook.setTheme(theme); String themeName = theme.getName();
  Parameters:
  
  value - The theme to apply to the workbook. Must not be null.
  
  Throws:
  
  IllegalArgumentException - if value is null.
- getIconSets
  
  IIconSets getIconSets()
  Gets the collection of icon sets available in the workbook.
  The returned IIconSets object can be used to retrieve built-in icon sets for icon set conditional formatting and icon-based filtering.
  
  worksheet.getRange("A1:A3").setValue(new Object[][] { {"Score"}, {30}, {90} }); IIconSetCondition condition = worksheet.getRange("A2:A3").getFormatConditions().addIconSetCondition(); condition.setIconSet(workbook.getIconSets().get(IconSetType.Icon3TrafficLights1)); IIconSets iconSets = workbook.getIconSets();
  Returns:
  
  The collection of icon sets available in the workbook.
- getWorksheets
  
  IWorksheets getWorksheets()
  Gets the IWorksheets collection that represents all worksheets in the workbook.
  This method returns the workbook-level worksheets collection. Use the returned collection to access worksheets by index or name, and to manage worksheets in the workbook.
  
  worksheet.setName("Summary"); IWorksheets sheets = workbook.getWorksheets(); IWorksheet firstSheet = sheets.get(0); IWorksheet summarySheet = sheets.get("Summary");
  Returns:
  
  The IWorksheets collection that represents all worksheets in the workbook.
- getSheetTabs
  
  ISheetTabs getSheetTabs()
  Gets the collection of sheet tabs contained in the workbook.
  Use the returned ISheetTabs object to access sheet tab information such as the number of tabs or a specific tab by index or name.
  
  ISheetTabs sheetTabs = workbook.getSheetTabs(); if (sheetTabs.getCount() > 0) { ISheetTab firstTab = sheetTabs.get(0); String tabName = firstTab.getName(); }
  Returns:
  
  An ISheetTabs object that represents the sheet tabs in the workbook.
- getActiveSheet
  
  IWorksheet getActiveSheet()
  Gets the active worksheet in the workbook.
  Returns the worksheet that is currently active in the workbook. Returns null if no worksheet is active.
  
  IWorksheet detailSheet = workbook.getWorksheets().add(); detailSheet.activate(); IWorksheet activeSheet = workbook.getActiveSheet();
  Returns:
  
  The active IWorksheet, or null if no worksheet is active.
- getSlicerCaches
  
  ISlicerCaches getSlicerCaches()
  Gets the ISlicerCaches collection associated with the workbook.
  Use this collection to access existing slicer caches in the workbook or to add new ones for supported data sources such as tables and PivotTables.
  
  worksheet.getRange("A1:B3").setValue(new Object[][]{ {"Category", "Amount"}, {"Fruit", 100}, {"Vegetable", 200} }); ITable table = worksheet.getTables().add(worksheet.getRange("A1:B3"), true); ISlicerCaches slicerCaches = workbook.getSlicerCaches(); ISlicerCache slicerCache = slicerCaches.add(table, "Category");
  Returns:
  
  The ISlicerCaches collection associated with the workbook.
- calculate
  
  void calculate()
  Calculates formulas in the workbook as needed.
  This method recalculates workbook formulas that require calculation. If iterative calculation is enabled, all formulas in the workbook are marked for recalculation before the calculation is performed.
  
  worksheet.getRange("A1").setValue(100); worksheet.getRange("B1").setFormula("=A1*2"); workbook.calculate(); Object value = worksheet.getRange("B1").getValue();
- dirty
  
  void dirty()
  Marks all formulas in the workbook as dirty so they are recalculated the next time calculation runs.
  Use this method to invalidate cached formula results for the entire workbook. After calling this method, invoke calculate(), or retrieve formula results while calculation is enabled, to trigger recalculation.
  
  worksheet.getRange("A1").setValue(1); worksheet.getRange("A2").setFormula("=A1*2"); workbook.dirty(); workbook.calculate(); Object value = worksheet.getRange("A2").getValue();
- fromJson
  
  List<JsonError> fromJson(String json)
  Loads workbook content from a SpreadJS JSON (SSJSON) string into this workbook.
  The returned list contains any JsonError objects found during deserialization.
  
  String json = "{\"version\":\"7.0.0\",\"sheets\":{\"Sheet1\":{\"data\":{\"dataTable\":{\"0\":{\"0\":{\"value\":\"Name\"},\"1\":{\"value\":\"Test\"}}}}}}}"; List<JsonError> errors = workbook.fromJson(json);
  Parameters:
  
  json - The SpreadJS JSON (SSJSON) string to load into this workbook. Must not be null.
  
  Returns:
  
  A list of JsonError objects found during deserialization.
- fromJson
  
  List<JsonError> fromJson(String json, DeserializationOptions deserializationOptions)
  Loads workbook content from a SpreadJS JSON (SSJSON) string into this workbook.
  Use this method to control deserialization behavior with a DeserializationOptions instance. The returned list contains any JsonError objects found during deserialization.
  
  String json = "{\"version\":\"7.0.0\",\"sheets\":{\"Sheet1\":{\"data\":{\"dataTable\":{\"0\":{\"0\":{\"value\":\"Name\"},\"1\":{\"value\":\"Test\"}}}}}}}"; DeserializationOptions options = new DeserializationOptions(); List<JsonError> errors = workbook.fromJson(json, options);
  Parameters:
  
  json - The SpreadJS JSON (SSJSON) string to load into this workbook. Must not be null.
  
  deserializationOptions - The DeserializationOptions object that controls how the JSON content is deserialized. If null, default deserialization options are used.
  
  Returns:
  
  A list of JsonError objects found during deserialization.
- fromJson
  
  List<JsonError> fromJson(InputStream stream)
  Loads workbook content from a SpreadJS JSON (SSJSON) stream into this workbook.
  The returned list contains any JsonError objects found during deserialization.
  
  worksheet.getRange("A1").setValue("Name"); String json = workbook.toJson(); DeserializationOptions options = new DeserializationOptions(); options.setDoNotRecalculateAfterLoad(true); List<JsonError> errors = workbook.fromJson( new ByteArrayInputStream(json.getBytes()) );
  Parameters:
  
  stream - The input stream that provides the SpreadJS JSON (SSJSON) content to load. Must not be null.
  
  Returns:
  
  A list of JsonError objects found during deserialization.
- fromJson
  
  List<JsonError> fromJson(InputStream stream, DeserializationOptions deserializationOptions)
  Loads workbook content from a SpreadJS JSON (SSJSON) stream into this workbook.
  Use this method to control deserialization behavior with a DeserializationOptions instance. The returned list contains any JsonError objects found during deserialization.
  
  worksheet.getRange("A1").setValue("Name"); String json = workbook.toJson(); DeserializationOptions options = new DeserializationOptions(); options.setDoNotRecalculateAfterLoad(true); List<JsonError> errors = workbook.fromJson( new ByteArrayInputStream(json.getBytes()), options );
  Parameters:
  
  stream - The input stream that provides the SpreadJS JSON (SSJSON) content to load. Must not be null.
  
  deserializationOptions - The DeserializationOptions object that controls how the JSON content is deserialized. If null, default deserialization options are used.
  
  Returns:
  
  A list of JsonError objects found during deserialization.
- toJson
  
  String toJson()
  Generates a JSON string from the workbook.
  Use this method to serialize the current workbook content to JSON.
  
  worksheet.getRange("A1:B2").setValue(new Object[][] { {"Name", "Value"}, {"Test", 100} }); String json = workbook.toJson();
  Returns:
  
  The JSON string that represents the current workbook.
- toJson
  
  String toJson(SerializationOptions serializationOptions)
  Generates a JSON string from the workbook using the specified serialization options.
  Use SerializationOptions to control how workbook content is serialized, such as whether styles or formulas are included in the generated JSON.
  
  worksheet.getRange("A1:B2").setValue(new Object[][] { {"Name", "Value"}, {"Test", 100} }); SerializationOptions options = new SerializationOptions(); options.setIgnoreStyle(true); String json = workbook.toJson(options);
  Parameters:
  
  serializationOptions - The SerializationOptions object that specifies how the workbook is serialized to JSON.
  
  Returns:
  
  The JSON string that represents the workbook.
- toJson
  
  void toJson(OutputStream stream)
  Generates a JSON stream from the workbook.
  This method writes the workbook content to the specified output stream in JSON format. The current implementation forwards to toJson(OutputStream,SerializationOptions) with null for the serialization options.
  
  worksheet.getRange("A1:B2").setValue(new Object[][] { {"Name", "Value"}, {"Test", 100} }); ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); workbook.toJson(outputStream); String json = new String(outputStream.toByteArray(), java.nio.charset.StandardCharsets.UTF_8);
  Parameters:
  
  stream - The output stream that receives the generated JSON data.
- toJson
  
  void toJson(OutputStream stream, SerializationOptions serializationOptions)
  Serializes the workbook to JSON and writes the content to the specified output stream.
  Use SerializationOptions to control how workbook content is serialized, such as whether styles or formulas are included in the generated JSON.
  
  worksheet.getRange("A1:B2").setValue(new Object[][] { {"Name", "Value"}, {"Test", 100} }); ByteArrayOutputStream stream = new ByteArrayOutputStream(); SerializationOptions serializationOptions = new SerializationOptions(); serializationOptions.setIgnoreStyle(true); workbook.toJson(stream, serializationOptions); String json = new String(stream.toByteArray(), java.nio.charset.StandardCharsets.UTF_8);
  Parameters:
  
  stream - The output stream that receives the generated JSON content.
  
  serializationOptions - The SerializationOptions object that specifies how the workbook is serialized to JSON.
- isEncryptedFile
  
  boolean isEncryptedFile(String fileName)
  Determines whether the specified file is password protected.
  Use this method to check whether a workbook file requires a password before opening it. If the file is encrypted, open it with open(String,String).
  
  worksheet.getRange("A1").setValue("Confidential"); String fileName = java.nio.file.Files.createTempFile("protected-report", ".xlsx").toString(); String password = getPasswordFromSecureSource(); workbook.save(fileName, password); boolean isEncrypted = workbook.isEncryptedFile(fileName);
  Parameters:
  
  fileName - The name or path of the file to check. Must not be null.
  
  Returns:
  
  true if the specified file is password protected; otherwise, false.
- isEncryptedFile
  
  boolean isEncryptedFile(InputStream fileStream)
  Determines whether the specified file stream is password protected.
  Use this method before opening a workbook stream to decide whether a password should be supplied to open(InputStream,String).
  
  worksheet.getRange("A1").setValue("Confidential"); ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); String password = getPasswordFromSecureSource(); workbook.save(outputStream, password); InputStream fileStream = new ByteArrayInputStream(outputStream.toByteArray()); boolean encrypted = workbook.isEncryptedFile(fileStream);
  Parameters:
  
  fileStream - The input file stream to inspect.
  
  Returns:
  
  true if the specified file stream is password protected; otherwise, false.
- open
  
  void open(String fileName)
  Opens a workbook file.
  This method opens the specified file by using the default open options. The file type is inferred from the file name extension.
  
  The fileName value is used directly as a file system path. Pass only validated paths from trusted sources.
  
  String filePath = java.nio.file.Paths.get(System.getProperty("user.dir"), "QuarterlyReport.xlsx").toString(); workbook.open(filePath);
  Parameters:
  
  fileName - The path and name of the workbook file to open. Must not be null.
- open
  
  List<JsonError> open(String fileName, DeserializationOptions deserializationOptions)
  Opens the specified JSON file.
  Uses the provided DeserializationOptions to control how the JSON content is deserialized into the workbook.
  
  DeserializationOptions options = new DeserializationOptions(); options.setIgnoreStyle(true); List<JsonError> errors = workbook.open("spread_js_exported.json", options);
  Parameters:
  
  fileName - The JSON file to open.
  
  deserializationOptions - The options that control JSON deserialization.
  
  Returns:
  
  A list of JsonError objects generated while opening the JSON file.
- open
  
  @Deprecated void open(String fileName, String password)
  
  Deprecated.
  Use open(String,OpenOptionsBase) instead.
  
  Opens the specified Excel file with a password.
  This method opens a password-protected workbook from the specified file path.
  
  Parameters:
  
  fileName - The path and name of the Excel file to open. Must not be null.
  
  password - The password for the file. Use the password required by the workbook; null if no password is needed.
- open
  
  void open(String fileName, OpenOptionsBase options)
  Opens a file with the specified open options.
  Use this overload to control how the workbook is loaded for supported file formats. The options argument can be an instance of CsvOpenOptions, SjsOpenOptions, XlsmOpenOptions, XlsxOpenOptions, or XltxOpenOptions.
  
  XlsxOpenOptions options = new XlsxOpenOptions(); options.setDoNotRecalculateAfterOpened(true); String fileName = java.nio.file.Paths.get(System.getProperty("user.dir"), "OpenWorkbookWithOptions.xlsx").toString(); workbook.open(fileName, options);
  Parameters:
  
  fileName - The file to open.
  
  options - The open options for the file. Must be compatible with the file format; null uses no explicit open options.
- open
  
  void open(String fileName, OpenFileFormat fileFormat)
  Opens a file using the specified file format.
  Use this overload when the file format should be provided explicitly instead of being inferred from the file name.
  
  workbook.open("Template.sjs", OpenFileFormat.Sjs); IWorksheet firstSheet = workbook.getWorksheets().get(0);
  Parameters:
  
  fileName - The file to open.
  
  fileFormat - The format of the file.
- open
  
  void open(InputStream fileStream)
  Opens the specified Excel file stream.
  Use this method to load workbook data from an InputStream.
  
  worksheet.getRange("A1").setValue("Name"); ByteArrayOutputStream stream = new ByteArrayOutputStream(); workbook.save(stream, SaveFileFormat.Xlsx); InputStream fileStream = new ByteArrayInputStream(stream.toByteArray()); workbook.open(fileStream);
  Parameters:
  
  fileStream - The stream that contains the Excel file data. Must not be null.
- open
  
  @Deprecated void open(InputStream fileStream, String password)
  
  Deprecated.
  Use open(InputStream,OpenOptionsBase) instead.
  
  Opens the specified Excel file stream with a password.
  Use this method to load a password-protected workbook from an InputStream.
  
  Parameters:
  
  fileStream - The file stream to open. Must not be null.
  
  password - The password for the file. Use an empty string if the file has no password.
- open
  
  void open(InputStream fileStream, OpenOptionsBase options)
  Opens the stream with specified options.
  String fileName = java.nio.file.Paths.get(System.getProperty("user.dir"), "Report.xlsx").toString(); XlsxOpenOptions options = new XlsxOpenOptions(); options.setDoNotRecalculateAfterOpened(true); try (InputStream fileStream = new java.io.FileInputStream(fileName)) { workbook.open(fileStream, options); } IWorksheet firstSheet = workbook.getWorksheets().get(0); String sheetName = firstSheet.getName();
  Parameters:
  
  fileStream - The file stream.
  
  options - The options used when opening the file stream. Possible types:
  
  CsvOpenOptions
  SjsOpenOptions
  XlsmOpenOptions
  XlsxOpenOptions
  XltxOpenOptions
- open
  
  void open(InputStream fileStream, OpenFileFormat fileFormat)
  Opens the specified format file stream.
  String fileName = java.nio.file.Paths.get(System.getProperty("user.dir"), "Report.xlsx").toString(); try (InputStream fileStream = new java.io.FileInputStream(fileName)) { workbook.open(fileStream, OpenFileFormat.Xlsx); } IWorksheet firstSheet = workbook.getWorksheets().get(0); String sheetName = firstSheet.getName();
  Parameters:
  
  fileStream - The specified file stream.
  
  fileFormat - The format of the file stream.
- save
  
  void save(String fileName)
  Saves the workbook to disk.
  worksheet.getRange("A1:B2").setValue(new Object[][] { {"Name", "Value"}, {"Test", 100} }); String filePath = java.nio.file.Paths.get(System.getProperty("user.dir"), "SalesReport.xlsx").toString(); workbook.save(filePath);
  Parameters:
  
  fileName - The path of the destination file.
- save
  
  void save(String fileName, String password)
  Saves the workbook to the specified Excel file with a password.
  Use this method to write the current workbook to disk and apply password protection to the saved file.
  
  worksheet.getRange("A1").setValue("Name"); worksheet.getRange("B1").setValue("Value"); worksheet.getRange("A2").setValue("Test"); worksheet.getRange("B2").setValue(100); String password = getPasswordFromSecureSource(); String filePath = java.nio.file.Paths.get(System.getProperty("user.dir"), "ProtectedReport.xlsx").toString(); workbook.save(filePath, password);
  Parameters:
  
  fileName - The path of the destination file.
  
  password - The password used to protect the saved file.
- save
  
  void save(String fileName, SaveOptionsBase options)
  Saves the workbook to a file with the specified save options.
  Use this method to control how the workbook is written by providing a SaveOptionsBase implementation for the target file type.
  
  worksheet.getRange("A1:B2").setValue(new Object[][] { {"Name", "Value"}, {"Test", 100} }); PdfSaveOptions options = new PdfSaveOptions(); workbook.save("report.pdf", options);
  Parameters:
  
  fileName - The path of the destination file.
  
  options - The save options that determine how the file is written. Supported types include CsvSaveOptions, HtmlSaveOptions, PdfSaveOptions, SjsSaveOptions, XlsmSaveOptions, XlsxSaveOptions, and XltxSaveOptions. null behavior is not specified.
- save
  
  void save(String fileName, SaveFileFormat fileFormat)
  Saves the workbook to the specified file in the specified format.
  Use this method when the target file format needs to be specified explicitly instead of being inferred from the file name.
  
  worksheet.getRange("A1:B2").setValue(new Object[][] { {"Name", "Value"}, {"Test", 100} }); String filePath = java.nio.file.Paths.get(System.getProperty("user.dir"), "SalesReport.xlsx").toString(); workbook.save(filePath, SaveFileFormat.Xlsx);
  Parameters:
  
  fileName - The path of the destination file.
  
  fileFormat - The file format to use when saving the workbook.
- save
  
  void save(OutputStream outputStream)
  Saves the workbook to the specified stream.
  Use this method to write the current workbook data to an OutputStream.
  
  worksheet.getRange("A1:B2").setValue(new Object[][] { {"Name", "Value"}, {"Test", 100} }); try (ByteArrayOutputStream outputStream = new ByteArrayOutputStream()) { workbook.save(outputStream); byte[] bytes = outputStream.toByteArray(); } catch (IOException e) { }
  Parameters:
  
  outputStream - The output stream to which the workbook is saved. Must not be null.
- save
  
  @Deprecated void save(OutputStream outputStream, String password)
  
  Deprecated.
  Use save(OutputStream,SaveOptionsBase) instead.
  
  Saves the workbook to the specified stream.
  
  Parameters:
  
  outputStream - The output stream to which the workbook is saved.
  
  password - The password of the file.
- save
  
  void save(OutputStream fileStream, SaveOptionsBase options)
  Saves the workbook to a stream with the specified save options.
  Use this method to write workbook data to an OutputStream and control the output by providing a SaveOptionsBase implementation. Supported option types include CsvSaveOptions, HtmlSaveOptions, PdfSaveOptions, SjsSaveOptions, XlsmSaveOptions, XlsxSaveOptions, and XltxSaveOptions.
  
  worksheet.getRange("A1:B2").setValue(new Object[][] { {"Name", "Value"}, {"Test", 100} }); XlsxSaveOptions options = new XlsxSaveOptions(); options.setIncludeAutoMergedCells(true); ByteArrayOutputStream stream = new ByteArrayOutputStream(); workbook.save(stream, options); byte[] bytes = stream.toByteArray();
  Parameters:
  
  fileStream - The destination stream to receive the saved workbook data.
  
  options - The save options that control how the workbook is written. This parameter should be an instance of a supported SaveOptionsBase derived type.
- save
  
  void save(OutputStream fileStream, SaveFileFormat fileFormat)
  Saves the workbook to the specified stream in the specified file format.
  Use this method to write the current workbook content to an OutputStream when the target format must be specified explicitly.
  
  worksheet.getRange("A1:B2").setValue(new Object[][] { {"Name", "Value"}, {"Test", 100} }); try (ByteArrayOutputStream outputStream = new ByteArrayOutputStream()) { workbook.save(outputStream, SaveFileFormat.Xlsx); byte[] bytes = outputStream.toByteArray(); } catch (Exception e) { // Handle exception }
  Parameters:
  
  fileStream - The destination stream to receive the saved workbook data. Must not be null.
  
  fileFormat - The format used to save the workbook to the stream.
- getUsedFonts
  
  List<FontInfo> getUsedFonts()
  Gets all font information used in the workbook.
  This method returns a collection of FontInfo objects that describe the fonts currently used by workbook content and styles.
  
  worksheet.getRange("A1").setValue("Title"); worksheet.getRange("A1").getFont().setName("Wide Latin"); worksheet.getRange("B1").setValue("Body"); worksheet.getRange("B1").getFont().setName("Calibri"); List<FontInfo> fonts = workbook.getUsedFonts();
  Returns:
  
  A list of FontInfo objects that represent the fonts used in the workbook.
- protect
  
  void protect()
  Protects the workbook structure without a password.
  The default call protects the workbook structure with structure set to true and leaves workbook window protection disabled because windows is false. This protection restricts workbook structure operations, such as adding, moving, deleting, hiding, unhiding, or renaming worksheets, in supported spreadsheet applications. It does not encrypt the workbook, provide content access control, or prevent changes made through the object model before saving.
  
  worksheet.getRange("A1").setValue("Quarterly Report"); worksheet.setVisible(false); workbook.protect();
- protect
  
  void protect(boolean structure)
  Protects a workbook so that it cannot be modified.
  If structure is true, workbook structure is protected to prevent other users from viewing hidden worksheets, adding, moving, deleting, or hiding worksheets, and renaming worksheets.
  
  worksheet.getRange("A1").setValue("Quarterly Report"); workbook.protect(true);
  Parameters:
  
  structure - true to protect the workbook structure; otherwise, false.
- protect
  
  void protect(boolean structure, boolean windows)
  Protects the workbook from modification based on the specified structure and window settings.
  Set structure to true to prevent users from viewing hidden worksheets, adding, moving, deleting, hiding, or renaming worksheets. Set windows to true to prevent users from moving, resizing, or closing the workbook window, or hiding and unhiding windows. The window protection option is available only in Excel 2007, Excel 2010, Excel for Mac 2011, and Excel 2016 for Mac.
  
  worksheet.getRange("A1").setValue("Quarterly Report"); workbook.protect(true, true);
  Parameters:
  
  structure - true to protect the workbook structure; otherwise, false.
  
  windows - true to protect the workbook windows; otherwise, false. This option is available only in Excel 2007, Excel 2010, Excel for Mac 2011, and Excel 2016 for Mac.
- protect
  
  void protect(String password)
  Protects the workbook with a password so that it cannot be modified.
  Use this method to apply workbook protection with a password. Protected workbooks prevent users from modifying the workbook when it is opened in a supported spreadsheet application.
  
  worksheet.getRange("A1").setValue("Quarterly Report"); // Get the password from user input via getPasswordFromSecureSource(). String password = getPasswordFromSecureSource(); workbook.protect(password); workbook.unprotect(password);
  Parameters:
  
  password - The password used to protect the workbook. If null or empty, the workbook is still protected without a password.
- protect
  
  void protect(String password, boolean structure)
  Protects the workbook so that it cannot be modified.
  If structure is true, workbook structure is protected to prevent other users from viewing hidden worksheets, adding, moving, deleting, or hiding worksheets, and renaming worksheets.
  
  worksheet.getRange("A1:B2").setValue(new Object[][] { {"Name", "Value"}, {"Test", 100} }); // Get the password from user input via getPasswordFromSecureSource(). String password = getPasswordFromSecureSource(); workbook.protect(password, true);
  Parameters:
  
  password - The password used to protect the workbook.
  
  structure - true to protect the workbook structure; otherwise, false.
- protect
  
  void protect(String password, boolean structure, boolean windows)
  Protects a workbook so that it cannot be modified.
  Use this overload to protect both workbook structure and workbook windows with a password. Set structure to true to prevent users from viewing hidden worksheets, adding, moving, deleting, hiding, or renaming worksheets. Set windows to true to prevent users from moving, resizing, or closing the workbook window, or hiding and unhiding windows.
  
  This protection only restricts workbook structure and window operations in supported spreadsheet applications. It does not encrypt workbook contents and should not be used as a confidentiality or access-control mechanism. To protect sensitive data, use file encryption such as password-protected XlsxSaveOptions or other access-control measures, and avoid storing unencrypted sensitive data in hidden worksheets.
  
  worksheet.getRange("A1").setValue("Quarterly Report"); // Get the password from user input via getPasswordFromSecureSource(). String password = getPasswordFromSecureSource(); workbook.protect(password, true, true); workbook.unprotect(password);
  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.
  Use this method to remove protection that was applied with protect() or another non-password overload of protect. If the workbook was protected with a password, use unprotect(String) with the correct password instead.
  
  worksheet.getRange("A1").setValue("Confidential"); workbook.protect(); workbook.unprotect();
- unprotect
  
  void unprotect(String password)
  Removes protection from the workbook.
  Pass the password that was used with protect(String) to remove workbook protection. If the workbook was protected without a password, the password argument is ignored.
  
  worksheet.getRange("A1").setValue("Confidential"); // Get the password from user input via getPasswordFromSecureSource(). String password = getPasswordFromSecureSource(); workbook.protect(password); workbook.unprotect(password);
  Parameters:
  
  password - The password used to protect the workbook. This value is ignored if the workbook was protected without a password.
- addDataSource
  
  void addDataSource(String name, Object dataSource)
  Adds a named data source for template processing.
  Use this method to register an alias that can be referenced by binding fields in a template. For example, after adding a data source with the alias title, the template can use {{title}}} in its binding fields.
  
  worksheet.getRange("A1").setValue("{{title}}"); String reportTitle = "Sales Report"; workbook.addDataSource("title", reportTitle); workbook.processTemplate(); Object value = worksheet.getRange("A1").getValue();
  Parameters:
  
  name - The alias name of the data source used by template binding fields.
  
  dataSource - The data source to register. Common choices include a JsonDataSource, a ResultSet, an ITableDataSource, a custom object or object collection, or a scalar value such as a string, number, or date.
- processTemplate
  
  void processTemplate()
  Processes the workbook as a template by evaluating template fields and replacing them with data from the workbook's data sources.
  Call this method after adding one or more data sources with addDataSource(String,Object).
  
  worksheet.getRange("A1").setValue("{{ds.name}}"); String json = "[{\"name\":\"jack\",\"age\":12,\"height\":160},{\"name\":\"alice\",\"age\":25,\"height\":165},{\"name\":\"peter\",\"age\":21,\"height\":180}]"; workbook.addDataSource("ds", new JsonDataSource(json)); workbook.processTemplate(); Object value = worksheet.getRange("A1").getValue();
- processTemplate
  
  void processTemplate(CancellationToken cancellationToken)
  Processes the workbook as a template and observes cancellation requests through the specified cancellation token.
  Use this method to process template data in the current workbook while allowing the operation to be canceled through a CancellationToken. If cancellation occurs, the workbook can remain in a partially processed state.
  
  worksheet.getRange("A1").setValue("{{ds.name}}"); String json = "[{\"name\":\"jack\",\"age\":12,\"height\":160},{\"name\":\"alice\",\"age\":25,\"height\":165},{\"name\":\"peter\",\"age\":21,\"height\":180}]"; workbook.addDataSource("ds", new JsonDataSource(json)); try (CancellationTokenSource cancellation = new CancellationTokenSource()) { workbook.processTemplate(cancellation.getToken()); } catch (Exception e) { // Handle exception }
  Parameters:
  
  cancellationToken - A token used to monitor cancellation requests. Pass null if cancellation is not required.
  
  Throws:
  
  CancellationException - if the specified CancellationToken is canceled while template processing is in progress.
  
  API Note:
  
  The caller must decide whether to keep the partially processed workbook or restore the previous state. If restoration is required, serialize the workbook before calling this method and deserialize it after the operation is canceled.
- generateReport
  
  IWorkbook generateReport()
  Processes the template and returns a new report workbook instance.
  Unlike processTemplate(), this method generates the report in a new IWorkbook so the current template workbook can be retained for further use.
  
  worksheet.getRange("A1").setValue("Class: {{className}}"); workbook.addDataSource("className", "Class 3"); IWorkbook report = workbook.generateReport(); Object value = report.getWorksheets().get(0).getRange("A1").getValue();
  Returns:
  
  A new IWorkbook instance that contains the generated report.
- generateReport
  
  IWorkbook generateReport(IWorksheet... worksheets)
  Processes the template and returns a new report workbook that includes only the specified worksheets.
  Use this method to generate a new IWorkbook from the current template workbook while limiting report generation to the provided worksheets.
  
  worksheet.getRange("A1").setValue("{{name}}"); workbook.addDataSource("name", "Quarterly Report"); IWorkbook report = workbook.generateReport(worksheet); Object value = report.getWorksheets().get(0).getRange("A1").getValue();
  Parameters:
  
  worksheets - The worksheets to process.
  
  Returns:
  
  A new IWorkbook object that contains the generated report.
- getGraphicsInfo
  
  IGraphicsInfo getGraphicsInfo()
  Gets the graphics information used by the workbook.
  If no graphics information has been assigned, the workbook uses built-in graphics information.
  
  worksheet.getRange("A1").setValue("12345"); class CustomGraphicsInfo implements IGraphicsInfo { @Override public double getDigitWidth(TextFormatInfo textFormat) { if ("Calibri".equals(textFormat.getFontFamily())) { return 8 * textFormat.getFontSize() / 11; } return 7 * textFormat.getFontSize() / 11; } } IGraphicsInfo graphicsInfo = new CustomGraphicsInfo(); workbook.setGraphicsInfo(graphicsInfo); IGraphicsInfo currentGraphicsInfo = workbook.getGraphicsInfo();
  Returns:
  
  The graphics information used by the workbook.
- setGraphicsInfo
  
  void setGraphicsInfo(IGraphicsInfo value)
  Sets the graphics information used by the workbook.
  Use this property to provide custom digit-width measurement logic for workbook rendering and layout calculations. If value is null, the workbook uses built-in graphics information.
  
  worksheet.getRange("A1").setValue("12345"); class CustomGraphicsInfo implements IGraphicsInfo { @Override public double getDigitWidth(TextFormatInfo textFormat) { if ("Calibri".equals(textFormat.getFontFamily())) { return 8 * textFormat.getFontSize() / 11; } return 7 * textFormat.getFontSize() / 11; } } IGraphicsInfo graphicsInfo = new CustomGraphicsInfo(); workbook.setGraphicsInfo(graphicsInfo);
  Parameters:
  
  value - The graphics information to use for digit-width measurement and related layout calculations. Set to null to use the built-in graphics information.
- getExcelLinkSources
  
  List<String> getExcelLinkSources()
  Gets the names of the linked Excel documents in the workbook.
  Use this method to retrieve the external workbook names referenced by cross-workbook formulas before calling updateExcelLink(String) or updateExcelLink(String,IWorkbook) to refresh linked data.
  
  worksheet.getRange("B1").setFormula("='[SourceIWorkbook.xlsx]Sheet1'!A1"); List<String> linkSources = workbook.getExcelLinkSources();
  Returns:
  
  A list of linked Excel document names.
- updateExcelLink
  
  void updateExcelLink(String name)
  Updates the Excel link with the specified name.
  Use this method to refresh a linked workbook reference identified by name. To obtain available link names, use getExcelLinkSources().
  
  String sourceFileName = "SourceWorkbook.xlsx"; IWorkbook sourceWorkbook = new Workbook(); sourceWorkbook.getWorksheets().get(0).getRange("A1").setValue("Updated value"); sourceWorkbook.save(sourceFileName); worksheet.getRange("B1").setFormula("='[" + sourceFileName + "]Sheet1'!A1"); for (String linkSource : workbook.getExcelLinkSources()) { workbook.updateExcelLink(linkSource); } Object updatedValue = worksheet.getRange("B1").getValue();
  Parameters:
  
  name - The name of the Excel link to update. This value should match one of the linked workbook names; null behavior is undefined.
- updateExcelLink
  
  void updateExcelLink(String name, IWorkbook sourceWorkbook)
  Updates a specified Excel link by using the content from another workbook.
  Use this method to refresh the cached data for one linked workbook referenced by formulas in the current workbook. The name should match the linked workbook name used in the external reference.
  
  worksheet.getRange("B1").setFormula("='[SourceWorkbook.xlsx]Sheet1'!A1"); IWorkbook sourceWorkbook = new Workbook(); sourceWorkbook.getWorksheets().get(0).getRange("A1").setValue("Hello"); workbook.updateExcelLink("SourceWorkbook.xlsx", sourceWorkbook); Object updatedValue = worksheet.getRange("B1").getValue();
  Parameters:
  
  name - The name of the linked workbook to update.
  
  sourceWorkbook - The workbook that provides the source data for the specified link. null behavior is undefined.
- updateExcelLinks
  
  void updateExcelLinks()
  Updates all Excel links in the workbook.
  Use this method to refresh the caches of external workbook links used by cross-workbook formulas.
  
  String sourceFileName = "SourceWorkbook.xlsx"; IWorkbook sourceWorkbook = new Workbook(); sourceWorkbook.getWorksheets().get(0).getRange("A1").setValue("Updated value"); sourceWorkbook.save(sourceFileName); worksheet.getRange("B1").setFormula("='[" + sourceFileName + "]Sheet1'!A1"); List<String> linkSources = workbook.getExcelLinkSources(); workbook.updateExcelLinks(); Object updatedValue = worksheet.getRange("B1").getValue();
- toSjsJson
  
  String toSjsJson()
  Generates a single JSON payload that represents the workbook in SpreadJS .sjs format.
  worksheet.getRange("A1:B2").setValue(new Object[][] { {"Name", "Value"}, {"Test", 100} }); String sjsJson = workbook.toSjsJson();
  Returns:
  
  A JSON string that contains the workbook content in SpreadJS .sjs format.
- toSjsJson
  
  String toSjsJson(SjsSaveOptions options)
  Generates a single JSON payload that represents the workbook in SpreadJS .sjs format, using the specified save options.
  worksheet.getRange("A1:B2").setValue(new Object[][] { {"Name", "Value"}, {"Test", 100} }); SjsSaveOptions options = new SjsSaveOptions(); options.setIncludeEmptyRegionCells(false); String sjsJson = workbook.toSjsJson(options);
  Parameters:
  
  options - The save options used to generate the SJS JSON content.
  
  Returns:
  
  A JSON string that contains the workbook content in SpreadJS .sjs format.
- toSjsJson
  
  void toSjsJson(OutputStream stream, SjsSaveOptions options)
  Integrates all JSON files in the SpreadJS .sjs format into a single string and writes it to the specified stream.
  Use SjsSaveOptions to control how workbook content is included when generating the SJS JSON output.
  
  worksheet.getRange("A1:B2").setValue(new Object[][] { {"Name", "Value"}, {"Test", 100} }); SjsSaveOptions options = new SjsSaveOptions(); options.setIncludeFormulas(true); ByteArrayOutputStream stream = new ByteArrayOutputStream(); workbook.toSjsJson(stream, options); String sjsJson = new String(stream.toByteArray(), java.nio.charset.StandardCharsets.UTF_8);
  Parameters:
  
  stream - The output stream that receives the integrated JSON string.
  
  options - The save options used when generating the SpreadJS .sjs JSON output.
- toSjsJson
  
  void toSjsJson(OutputStream stream)
  Writes a JSON string that combines all JSON parts of the SpreadJS .sjs content for this workbook to the specified stream.
  Use this method to export the workbook as a single SJS JSON payload through an OutputStream.
  
  worksheet.getRange("A1:B2").setValue(new Object[][] { {"Name", "Value"}, {"Test", 100} }); ByteArrayOutputStream stream = new ByteArrayOutputStream(); workbook.toSjsJson(stream); String sjsJson = new String(stream.toByteArray(), java.nio.charset.StandardCharsets.UTF_8);
  Parameters:
  
  stream - The output stream that receives the generated SJS JSON content. Must not be null.
- convertBarcodeToPicture
  
  void convertBarcodeToPicture()
  Converts calculated barcode formulas to pictures and places the pictures at their original positions.
  The original barcode formulas are cleared after the conversion. The converted pictures use ImageType.SVG.
  
  worksheet.getRange("B2").setValue("Policy:411"); worksheet.getRange("C2").setFormula("=BC_QRCODE(B2)"); workbook.calculate(); workbook.convertBarcodeToPicture(); int pictureCount = worksheet.getShapes().getCount(); String fileName = "BarcodeReport.xlsx"; workbook.save(fileName);
- convertBarcodeToPicture
  
  void convertBarcodeToPicture(ImageType imageType)
  Converts calculated barcode formulas to pictures.
  The converted pictures are placed at the original barcode positions, and the original barcode formulas are cleared after the conversion.
  
  worksheet.getRange("A1").setValue("Policy:411"); worksheet.getRange("B1").setFormula("=BC_QRCODE(A1)"); workbook.convertBarcodeToPicture(ImageType.JPG); int pictureCount = worksheet.getShapes().getCount(); String fileName = "BarcodeReportJpg.xlsx"; workbook.save(fileName);
  Parameters:
  
  imageType - The ImageType of the converted barcode pictures.
  
  Throws:
  
  UnsupportedOperationException - if imageType is ImageType.EMF or ImageType.WMF.
- fromSjsJson
  
  void fromSjsJson(String json)
  Generates a workbook from a JSON string containing .sjs file content.
  worksheet.getRange("A1").setValue("Name"); worksheet.getRange("B1").setValue("Value"); String sjsJson = workbook.toSjsJson(); IWorkbook importedWorkbook = new Workbook(); importedWorkbook.fromSjsJson(sjsJson);
  Parameters:
  
  json - The JSON string containing .sjs file content.
- fromSjsJson
  
  void fromSjsJson(String json, SjsOpenOptions openOptions)
  Generates a workbook from a JSON string containing SpreadJS .sjs file content, using the specified SjsOpenOptions.
  worksheet.getRange("A1:B2").setValue(new Object[][] { {"Name", "Value"}, {"Test", 100} }); String json = workbook.toSjsJson(); SjsOpenOptions openOptions = new SjsOpenOptions(); IWorkbook importedWorkbook = new Workbook(); importedWorkbook.fromSjsJson(json, openOptions);
  Parameters:
  
  json - The JSON string that contains workbook data in SpreadJS .sjs format.
  
  openOptions - The options used to open the SpreadJS .sjs content.
- fromSjsJson
  
  void fromSjsJson(InputStream stream, SjsOpenOptions openOptions)
  Generates a workbook from a JSON stream containing .sjs file content.
  worksheet.getRange("A1:B2").setValue(new Object[][] { {"Name", "Value"}, {"Test", 100} }); String json = workbook.toSjsJson(); SjsOpenOptions openOptions = new SjsOpenOptions(); IWorkbook importedWorkbook = new Workbook(); try (InputStream stream = new ByteArrayInputStream(json.getBytes(java.nio.charset.StandardCharsets.UTF_8))) { importedWorkbook.fromSjsJson(stream, openOptions); }
  Parameters:
  
  stream - The JSON stream.
  
  openOptions - The open options for opening SpreadJS .sjs file.
- fromSjsJson
  
  void fromSjsJson(InputStream stream)
  Loads a workbook from a JSON stream that contains SpreadJS .sjs file content.
  worksheet.getRange("A1").setValue("Name"); ByteArrayOutputStream stream = new ByteArrayOutputStream(); workbook.toSjsJson(stream); InputStream inputStream = new ByteArrayInputStream(stream.toByteArray()); IWorkbook importedWorkbook = new Workbook(); importedWorkbook.fromSjsJson(inputStream);
  Parameters:
  
  stream - The JSON stream that contains SpreadJS .sjs file content. Must not be null.
- waitForCalculationToFinish
  
  void waitForCalculationToFinish()
  Waits for all calculations in the workbook to finish.
  This method blocks the current thread until all pending calculations, including asynchronous calculations, have completed. Call this method before performing operations that depend on calculated results.
  
  worksheet.getRange("A1").setFormula("=IMAGE(\"https://example.com/logo.jpg\")"); workbook.calculate(); workbook.waitForCalculationToFinish(); CellPicture picture = worksheet.getRange("A1").getCellPicture();
- getShowPivotTableFieldList
  
  boolean getShowPivotTableFieldList()
  Gets a value indicating whether the PivotTable field list can be shown.
  Use this property to determine whether users can display the PivotTable field list for PivotTables in the workbook. The default value is true.
  
  worksheet.getRange("A1:B4").setValue(new Object[][] { {"Product", "Sales"}, {"Laptop", 1200}, {"Tablet", 900}, {"Laptop", 700} }); IPivotCache pivotCache = workbook.getPivotCaches().create(worksheet.getRange("A1:B4")); IPivotTable pivotTable = worksheet.getPivotTables().add(pivotCache, worksheet.getRange("D1"), "SalesPivot"); pivotTable.getPivotFields().get("Product").setOrientation(PivotFieldOrientation.RowField); pivotTable.addDataField(pivotTable.getPivotFields().get("Sales"), "Sum of Sales", ConsolidationFunction.Sum); workbook.setShowPivotTableFieldList(false); boolean canShowFieldList = workbook.getShowPivotTableFieldList();
  Returns:
  
  true if the PivotTable field list can be shown; otherwise, false.
- setShowPivotTableFieldList
  
  void setShowPivotTableFieldList(boolean value)
  Sets a value indicating whether the PivotTable field list can be shown.
  Use this property to set whether users can display the PivotTable field list for PivotTables in the workbook.
  
  worksheet.getRange("A1:B4").setValue(new Object[][] { {"Product", "Sales"}, {"Laptop", 1200}, {"Tablet", 900}, {"Laptop", 700} }); IPivotCache pivotCache = workbook.getPivotCaches().create(worksheet.getRange("A1:B4")); IPivotTable pivotTable = worksheet.getPivotTables().add(pivotCache, worksheet.getRange("D1"), "SalesPivot"); pivotTable.getPivotFields().get("Product").setOrientation(PivotFieldOrientation.RowField); pivotTable.addDataField(pivotTable.getPivotFields().get("Sales"), "Sum of Sales", ConsolidationFunction.Sum); workbook.setShowPivotTableFieldList(false); boolean canShowFieldList = workbook.getShowPivotTableFieldList();
  Parameters:
  
  value - true if the PivotTable field list can be shown; otherwise, false.
- clone
  
  IWorkbook clone()
  
  Clones the current workbook and returns a new workbook instance.
  The cloned workbook is an exact copy of the current workbook at the time this method is called. Changes made to the cloned workbook do not affect the original workbook.
  
  For user-defined objects stored in workbook content, the cloning process uses the object's clone implementation when available. Otherwise, those objects are copied by reference. IWorkbook and worksheet events are not cloned and must be registered again on the cloned workbook if needed.
  
  Returns:
  
  A new IWorkbook instance that is an exact copy of the current workbook.

Interface IWorkbook

Method Summary

Method Details

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

getCustomXmlParts

getCustomViews

getWriteProtection

getEnableCalculation

setEnableCalculation

getCulture

setCulture

getDefaultTableStyle

setDefaultTableStyle

getNames

getAuthor

setAuthor

getPivotCaches

getReferenceStyle

setReferenceStyle

getStyles

getTableStyles

getTheme

setTheme

getIconSets

getWorksheets

getSheetTabs

getActiveSheet

getSlicerCaches

calculate

dirty

fromJson

fromJson

fromJson

fromJson

toJson

toJson

toJson

toJson

isEncryptedFile

isEncryptedFile

open

open

open

open

open

open

open

open

open