Export (0) Print
Expand All

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

JavaScript API for Office v1.1

Adds a binding to the current selection in the document.

Last modified: June 12, 2014

Introduced in Office.js version

1.0

Updated in Office.js version

1.1

Available in requirement sets

MatrixBindings, TableBindings, TextBindings

bindingsObj.addFromSelectionAsync(bindingType [, options], callback);

bindingType

Type: BindingType

Specifies the type of the binding object to create. Required.

Returns null if the selected object cannot be coerced into the specified type.

options

Type:object

Specifies the following optional parameters.

id

Type: string

Specifies the unique name to be used to identify the new binding object. Optional.

If no argument is passed for the id parameter, the Binding.id is autogenerated.

asyncContext

Type: 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. 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 addFromSelectionAsync method, you can use the properties of the AsyncResult object to return the following information.

Property

Use to...

AsyncResult.value

Access the Binding object that represents the selection specified by the user.

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.

Adds the specified type of binding object to the Bindings collection, which will be identified with the supplied id.

Note Note

In Excel, if you call the addFromSelectionAsync method passing in the Binding.id of an existing binding, the Binding.type of that binding is used, and its type cannot be changed by specifying a different value for the bindingType parameter.

If you need to use an existing id and change the bindingType, call the Bindings.releaseByIdAsync method first to release the binding, and then call the addFromSelectionAsync method to reestablish the binding with a new type.

  • In apps for Access, you can create table bindings.

  • In apps for Excel, you can create a table binding (passing bindingType as Office.BindingType.Table) for a range of cells that contains tabular data even when that data was not added to the spreadsheet as a table (by using the Insert > Tables >Table or Home > Styles > Format as Table commands).

Adds a TextBinding to the current selection with a Binding.id of 'MyBinding'.

function addBindingFromSelection() {
    Office.context.document.bindings.addFromSelectionAsync(Office.BindingType.Text, { id: 'MyBinding' }, 
        function (asyncResult) {
        write('Added new 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