ExcelWorkbook | OpenFin Excel Integration API Reference

An object that represents an open workbook in Excel.

Hierarchy

ExcelWorkbook

Index

Methods

activate

activate(): Promise<void>

Activates the first window associated with the workbook, bringing it in to focus.

Note: activating a workbook deactivates the currently activated workbook.

Returns Promise<void>

addEventListener

addEventListener(eventName: string, listener: ExcelWorkbookEventListener): Promise<void>
addEventListener(eventName: "activate", listener: WorkbookActivatedEventListener): Promise<void>
addEventListener(eventName: "addWorksheet", listener: WorksheetAddedEventListener): Promise<void>
addEventListener(eventName: "close", listener: WorkbookClosedEventListener): Promise<void>
addEventListener(eventName: "deactivate", listener: WorkbookDeactivatedEventListener): Promise<void>
addEventListener(eventName: "deleteWorksheet", listener: WorksheetDeletedEventListener): Promise<void>

Adds a listener for the specified workbook-level event.

throws
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.

throws
EventError if specified event is not supported.

Parameters
- eventName: string
  
  Type of the workbook-level event to listen for.
- listener: ExcelWorkbookEventListener
  
  Function called when the specified event occurs.
Returns Promise<void>
Adds a listener that is called when the workbook is activated.

throws
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.

Parameters
- eventName: "activate"
  
  Name of the event fired when the workbook is activated.
- listener: WorkbookActivatedEventListener
  
  Listener function called when the event occurs.
Returns Promise<void>
Adds a listener that is called when a worksheet is added to the workbook.

throws
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.

Parameters
- eventName: "addWorksheet"
  
  Name of the event fired when a worksheet is added to the workbook.
- listener: WorksheetAddedEventListener
  
  Listener function called when the event occurs.
Returns Promise<void>
Adds a listener that is called when the workbook is closed.

throws
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.

Parameters
- eventName: "close"
  
  Name of the event fired when the workbook is closed.
- listener: WorkbookClosedEventListener
  
  Listener function called when the event occurs.
Returns Promise<void>
Adds a listener that is called when the workbook is deactivated (i.e. another workbook is activated).

throws
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.

Parameters
- eventName: "deactivate"
  
  Name of the event fired when the workbook is deactivated.
- listener: WorkbookDeactivatedEventListener
  
  Listener function called when the event occurs.
Returns Promise<void>
Adds a listener that is called when a worksheet is deleted from the workbook.

throws
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.

Parameters
- eventName: "deleteWorksheet"
  
  Name of the event fired when a worksheet is deleted from the workbook.
- listener: WorksheetDeletedEventListener
  
  Listener function called when the event occurs.
Returns Promise<void>

addWorksheet

addWorksheet(): Promise<ExcelWorksheet>

Adds a new worksheet to the workbook.

throws
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.

Returns Promise<ExcelWorksheet>
The worksheet that was created.

close

close(): Promise<void>

Closes the workbook.

If the workbook has any unsaved changes, Excel displays a "Save" prompt before closing the workbook.

Note: 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.

throws
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.

Returns Promise<void>

getName

getName(): Promise<string>

Gets the name of the workbook.

throws
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.

Returns Promise<string>
The workbook name.

getProperty

getProperty<T>(propertyName: string): Promise<null | T>

Gets the value of a property from the Excel PIA Workbook interface.

Refer to the Workbook interface properties documentation for a list of valid property names. The property name is case-sensitive so be sure to enter it exactly as it appears in the documentation.

Note: only properties that are a value type or a string are supported and can be retrieved using this function.

throws
AdapterError if the requested property is not a supported type, or if an exception is thrown by the adapter process, typically by the Excel PIA.

Type parameters
- T = any
  
  The type of the property whose value to get.
Parameters
- propertyName: string
  
  The name of the property whose value to get.
Returns Promise<null | T>
The value of the property or null if the requested property does not exist.

getWorksheetByName

getWorksheetByName(worksheetName: string): Promise<null | ExcelWorksheet>

Gets a worksheet with a given name.

throws
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.

Parameters
- worksheetName: string
  
  The name of the worksheet to get.
Returns Promise<null | ExcelWorksheet>
The worksheet matching the provided name, or null if no matching worksheet was found.

getWorksheets

getWorksheets(): Promise<ExcelWorksheet[]>

Gets all worksheets belonging to the workbook.

throws
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.

Returns Promise<ExcelWorksheet[]>
All worksheets belonging to the workbook.

removeEventListener

removeEventListener(listener: ExcelWorkbookEventListener): Promise<void>

Removes a previously added listener for the specified workbook-level event.

throws
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.

throws
EventError if provided listener function does not match any added event listener.

Parameters
- listener: ExcelWorkbookEventListener
  
  Function that was provided as the listener when addEventListener was called.
Returns Promise<void>

save

save(): Promise<void>

Saves the workbook to disk.

throws
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.

Returns Promise<void>

saveAs

saveAs(filePath: string): Promise<void>

Saves the workbook to the file path provided.

throws
AdapterError if an exception is thrown by the adapter process, typically by the Excel PIA.

Parameters
- filePath: string
  
  Full path (including file name) where the workbook should be saved.
Returns Promise<void>

Hierarchy

Index

Methods

Methods

activate

Returns Promise<void>

addEventListener

Parameters

eventName: string

listener: ExcelWorkbookEventListener

Returns Promise<void>

Parameters

eventName: "activate"

listener: WorkbookActivatedEventListener

Returns Promise<void>

Parameters

eventName: "addWorksheet"

listener: WorksheetAddedEventListener

Returns Promise<void>

Parameters

eventName: "close"

listener: WorkbookClosedEventListener

Returns Promise<void>

Parameters

eventName: "deactivate"

listener: WorkbookDeactivatedEventListener

Returns Promise<void>

Parameters

eventName: "deleteWorksheet"

listener: WorksheetDeletedEventListener

Returns Promise<void>

addWorksheet

Returns Promise<ExcelWorksheet>

close

Returns Promise<void>

getName

Returns Promise<string>

getProperty

Type parameters

T = any

Parameters

propertyName: string

Returns Promise<null | T>

getWorksheetByName

Parameters

worksheetName: string

Returns Promise<null | ExcelWorksheet>

getWorksheets

Returns Promise<ExcelWorksheet[]>

removeEventListener

Parameters

listener: ExcelWorkbookEventListener

Returns Promise<void>

save

Returns Promise<void>

saveAs

Parameters

filePath: string

Returns Promise<void>