Bindings.getByIdAsync method (JavaScript API for Office)

apps for Office

Gets the specified binding by its identifier.

Last modified: February 27, 2015

Hosts:

Access, Excel, Word

Available in Requirement set

CustomXmlParts, MatrixBindings, TableBindings, TextBindings

Last changed in

1.1

See all support details

bindingsObj.getByIdAsync(id [, options], callback);

Name

Type

Description

Support notes

id

string

Specifies the unique name to be used to identify the binding object. Required.

options

object

Specifies any of the following optional parameters

asyncContext

array, boolean, null, number, object, string, or undefined

A user-defined item of any type that is returned in the AsyncResult object without being altered.

callback

object

A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.

When the function you passed to the callback parameter executes, it receives an AsyncResult object that you can access from the callback function's only parameter.

In the callback function passed to the getByIdAsync method, you can use the properties of the AsyncResult object to return the following information.

Property

Use to...

AsyncResult.value

Access the Binding object specified by the id in the call.

AsyncResult.status

Determine the success or failure of the operation.

AsyncResult.error

Access an Error object that provides error information if the operation failed.

AsyncResult.asyncContext

Access your user-defined object or value, if you passed one as the asyncContext parameter.

Fails if the specified id does not exist.

function displayBindingType() {
    Office.context.document.bindings.getByIdAsync('MyBinding', function (asyncResult) {
        write('Retrieved binding with type: ' + asyncResult.value.type + ' and id: ' + asyncResult.value.id);
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

A checkmark (√) 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 apps for Office.

Office for Windows desktop

Office for Windows RT

Office Online
(in browser)

Access

Excel

Word

Available in requirement sets

CustomXmlParts, MatrixBindings, TableBindings, TextBindings

Minimum permission level

ReadDocument

App types

Content, task pane

Library

Office.js

Namespace

Office

Version

Changes

1.1

Added support for table binding in content apps for Access.

1.0

Introduced

Show:
© 2015 Microsoft