Gets the workbook name.
The workbook name.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Adds a listener for the specified workbook-level event.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
EventError if specified event is not supported.
Type of the workbook-level event to listen for.
Function called when the specified event occurs.
Adds a listener that is called when the workbook is activated.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Name of the event fired when the workbook is activated.
Listener function called when the event occurs.
Adds a listener that is called when a worksheet is added to the workbook.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Name of the event fired when a worksheet is added to the workbook.
Listener function called when the event occurs.
Adds a listener that is called when the workbook is closed.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Name of the event fired when the workbook is closed.
Listener function called when the event occurs.
Adds a listener that is called when the workbook is deactivated (i.e. another workbook is activated).
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Name of the event fired when the workbook is deactivated.
Listener function called when the event occurs.
Adds a listener that is called when a worksheet is deleted from the workbook.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Name of the event fired when a worksheet is deleted from the workbook.
Listener function called when the event occurs.
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.
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 a worksheet with a given name.
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.
The name of the worksheet to get.
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-level event.
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.
Function that was provided as the listener when addEventListener was called.
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.
The full path the workbook was saved to.
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.
Full path (including file name) where the workbook should be saved.
Generated using TypeDoc
An object that represents an open workbook in Excel.