Export (0) Print
Expand All

Bindings.getByIdAsync method (JavaScript API for Office v1.1)

JavaScript API for Office v1.1

Gets the specified binding by its identifier.

Last modified: June 12, 2014

Introduced in Office.js version

1.0

Updated in Office.js version

1.1

Available in requirement sets

CustomXmlParts, MatrixBindings, TableBindings, TextBindings

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

id

Type: string

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

options

Type:object

Specifies the following optional parameters.

asyncContext

Type: object

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

callback

Type: object

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

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.

In version 1.1 of Office.js, you can now create table bindings in content apps for Access.

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; 
}

App types

Content apps, Task pane apps

Supported clients

Access app for SharePoint, Excel 2013, Excel 2013 SP1, Excel 2013 RT, Excel Online, Word 2013, Word 2013 SP1, Word 2013 RT

Library

Office.js

Namespace

Office

Show:
© 2014 Microsoft