This topic has not yet been rated - Rate this topic

Bindings.getByIdAsync method (apps for Office)

apps for SharePoint

Published: February 26, 2013

Gets the specified binding by its identifier.

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

Parameters

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.

Callback Value

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. Use the AsyncResult.value property to access the Binding object specified in the call to the getByIdAsync method. To determine the success or failure of the operation, use the AsyncResult.status property. If the operation failed, use the AsyncResult.error property to access an Error object that provides information about the error. If you passed a user-defined object to the asyncContext parameter, use the AsyncResult.asyncContext property to access that object.

Remarks

Fails if the specified id does not exist.

Example

JavaScript

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

Requirements

Supported clients	Excel 2013, Excel Web App, Word 2013
Library	Office.js
Namespace	Office

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD