Optionaloptions: IWorkbook.ConstructorOptionsFor runtime type checking.
Returns any custom workbook options that are provided in constructor.
Batches all 'transactional' changes until they have all be committed or rolled back.
Optionaloptions: string | OperationOptionsDescription of the operation or additional options. Used for tracking undo/redo and history. Default Value User Operation.
Any changes that are made to this object will be reflected in the local record but not committed to the transactional store until the batch is popped.
Useful for operations that are longer running but generally not recommended as it keeps a transaction open. doBatch is the preferred option.
Provides a mechanism to perform a set of operations in a batch.
A callback that performs multiple operations all within the same transaction.
Optionaloptions: string | OperationOptionsDescription of the operation or additional options. Used for tracking undo/redo and history. Default Value User Operation.
Search the entire Workbook.
The text to search for.
Optionaloptions: FindOptionsGiven the name return a valid name that closely matches.
The string to validate.
Returns the ICalculation for the workbook.
Returns the named collection for the workbook.
These are sorted/filtered by type then by name.
Returns the next sheet in the sheets collection. If the last one it will return the first.
Returns the previous sheet in the sheets collection. If the first one it will return the last.
Returns the protection object for the workbook.
Returns ranges scoped to a sheet.
Address of the ranges.
Optionaloptions: GetRangeOptionsWhen accessing ranges from the IWorkbook ranges include a sheet name.
This enables cross-sheet references when working at the workbook level.
Some examples of cross-sheet reference are:
Linking data and formulas across multiple sheets.
Consolidating data from different sheets for analysis or reporting.
Performing calculations or comparisons that involve values from multiple sheets.
Returns an a set of ranges including sheet names.
Address of the ranges.
Optionaloptions: GetRangeOptionsReturns the current shared resources.
Returns any user defined functions stored with the workbook.
Returns the selected cell.
Returns a range of cells for the current selection.
Optionaloptions: GetRangeOptionsReturns ranges of cells for the current selection.
Optionaloptions: GetRangeOptionsReturns the currently active sheet within the workbook.
Returns the currently active sheet index within the workbook.
Returns the sheet for the given name.
The name of the sheet.
The visibility of the sheet.
Returns the sheet at the given offset.
A 0-based index of the sheet.
The visibility of the sheet.
Returns the collection of sheets within the workbook.
Returns the current shared resources.
Returns the current IStyleCollection associated with this Workbook.
Get the current theme.
Returns the current shared resources.
Returns the current view settings.
View settings determine how specific workbook level elements are displayed but does not affect the underlying data itself.
Indicates if the model has been closed.
Is date resolution 1904 instead of 1900 based.
Indicate if the current character is a valid character for a sheetName.
The string to validate.
Replace all items in the iterator
An iterator of cells to replace.
The ICell.Update or a callback to replace with.
Optionaloptions: ReplaceOptionsDetermine if dates should be 1904 instead of 1900 based.
default value false
Views have their own lifecycle because in a collaborative environment each user can have their own view.
Serialize the workbook to a JSON.
If true only meta data about the workbook will be saved.
Returns a string representation of an object.
The Base implementation of IWorkbook.