Adds a listener for the specified workbook event.
Type of the workbook event to listen for.
Function called when the specified event occurs.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
EventError if specified event is not supported.
Adds a listener that is called when the workbook is activated.
Name of the event fired when the workbook is activated.
Function called when the specified event occurs.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Adds a listener that is called when a worksheet is activated in the workbook.
Name of the event fired when a worksheet is activated in the workbook.
Function called when the specified event occurs.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Adds a listener that is called when a worksheet is added to the workbook.
Name of the event fired when a worksheet is added to the workbook.
Function called when the specified event occurs.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Adds a listener that is called when the workbook is closed.
Name of the event fired when the workbook is closed.
Function called when the specified event occurs.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Adds a listener that is called when the workbook is deactivated (i.e. another workbook is activated).
Name of the event fired when the workbook is deactivated.
Function called when the specified event occurs.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Adds a listener that is called when a worksheet is deleted from the workbook.
Name of the event fired when a worksheet is deleted from the workbook.
Function called when the specified event occurs.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Adds a new worksheet to the workbook.
The worksheet that was created.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Triggers calculation for the entire workbook.
Only necessary when automatic calculation is turned off.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Closes the workbook.
If the workbook has any unsaved changes, Excel displays a "Save" prompt before closing the workbook.
After calling this function do not attempt to use this workbook or any child worksheet objects. Doing so will likely result in an AdapterError since the underlying object/file is no longer available.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Gets the active worksheet.
The active worksheet.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Get the current calculation mode which determines when the workbook is re-calculated.
The name of the current calculation mode.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Gets the workbook file path.
The workbook file path if saved, otherwise returns null
.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Gets the workbook name.
The workbook name.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Gets the workbook window’s size and position.
The workbook window’s height, width and top and left position in points.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Gets a worksheet with a given name.
The name of the worksheet to get.
The worksheet matching the provided name, or null
if no matching worksheet was found.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Gets all worksheets belonging to the workbook.
All worksheets belonging to the workbook.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Removes a previously added listener for the specified workbook event.
Function that was provided as the listener when addEventListener
was called.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
EventError if provided listener
function does not match any added event listener.
Saves the workbook to disk.
The full path the workbook was saved to.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Saves the workbook to the file path provided.
Full path (including file name) where the workbook should be saved.
The full path the workbook was saved to.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Sets the workbook window’s size and position.
The new height, width and top and left position in points to set for the workbook window.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Generated using TypeDoc
An object that represents an open workbook in Excel.