ApiWorkbook

Class representing the currently active workbook

Properties

Name	Type	Description
TableStyles	ApiTableStyles	Returns the collection of table styles of the workbook.

Methods

The following table lists the available methods.

Method	Returns	Description
BreakLink	boolean	Breaks the link to the specified workbook: the formulas that refer to it are replaced with their current values, and the link is removed from the workbook.
Calculate	boolean	Recalculates the cells that need recalculation (changed, added or volatile) across the workbook. Forces the recalc that is otherwise deferred until a macro finishes, so up-to-date formula results can be read within the same macro.
GetActiveChart	ApiChart | null	Returns the active chart of the workbook.
GetActiveSheet	ApiWorksheet	Returns the active sheet of the workbook.
GetAllPivotTables	ApiPivotTable[]	Returns all pivot tables in the workbook.
GetCustomProperties	ApiCustomProperties	Returns the custom properties of the workbook.
GetDrawingsByName	Drawing[]	Returns drawings with the specified names from the workbook.
GetLinkSources	string[]	Returns the paths of the other workbooks registered as external links of the current workbook, including links no formula uses any longer.
GetName	string	Returns the name of the workbook.
GetSheets	ApiWorksheet[]	Returns a sheet collection that represents all the sheets in the workbook.
GetTheme	ApiTheme	Returns the theme of the workbook.
Redraw	boolean	Redraws the editor screen, making the changes already made by a macro visible without waiting for it to finish. Observable from asynchronous code only. Repaints without recalculating: call ApiWorkbook#Calculate first if formula results must be up to date.
Save	None	Saves changes to the specified document.