Docs API Reference

Bindings.addFromSelectionAsync method

Adds a binding to the current selection in the document.

Hosts: Access, Excel, Word
Available in Requirement set MatrixBindings, TableBindings, TextBindings
Last changed 1.1
bindingsObj.addFromSelectionAsync(bindingType [, options], callback);

Parameters

Name Type Description Support notes
bindingType 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 object Specifies any of the following optional parameters.
id string Specifies the unique name to be used to identify the new binding object.If no argument is passed for the id parameter, the Binding.id is autogenerated.
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.

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.

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.

Remarks

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

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.

Example

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

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 Y
Available in requirement sets MatrixBindings, TableBindings, TextBindings
Minimum permission level ReadDocument
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 In add-ins 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).
1.1 Added support for table binding in content add-ins for Access.
1.0 Introduced