Docs API Reference

Bindings object

Represents the bindings the add-in has within the document.

Hosts: Access, Excel, Word
Last changed in 1.1
Office.context.document.bindings

Properties

Name Description
document Gets a Document object that represents the document associated with this set of bindings.

Methods

Name Description
addFromNamedItemAsync Adds a binding to a named item in the document.
addFromPromptAsync Displays UI that enables the user to specify a selection to bind to.
addFromSelectionAsync Adds a binding object of the type specified bound to the current selection in the document.
getAllAsync Gets all bindings that were previously created.
getByIdAsync Gets the specified binding by its identifier.
releaseByIdAsync Removes the specified binding.

Support details

A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.

For more information about Office host application and server requirements, see Requirements for running Office Add-ins.

Office for Windows desktop Office Online (in browser) Office for iPad
Access Y
Excel Y Y Y
Word Y Y
Add-in types Content, task pane
Library Office.js
Namespace Office

Support history

Version Changes
1.1 Added support for Excel and Word in Office for iPad
1.1 For addFromNamedItemAsync, addFromPromptAsync, and addFromSelectionAsync added support for binding to matrix data as a table binding in add-ins for Excel.
1.1
  • For document property, added access to a Document object that represents the current Access database in content add-ins for Access.
  • For all methods, added support for table binding in content add-ins for Access.
1.0 Introduced