Office.select method

Creates a promise to return a binding based on the selector string passed in.

Office.select(str, onError);

Parameters

str
    Type: string
    The selector string to parse and create a promise for.

onError
    Type: function
    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 onError parameter executes, it receives an AsyncResult object that you can access from the callback function's only parameter. If the operation failed, use the AsyncResult.error property to access an Error object that provides information about the error.

Remarks

The Office.select method provides access to a Binding object promise that attempts to return the specified binding when any of its asynchronous methods are invoked.

Supported formats: "bindings# bindingId", which returns a Binding object for the binding with the id of bindingId. For more information, see Asynchronous programming in Office Add-ins and Bind to regions in a document or spreadsheet.

Note: If the select method promise successfully returns a Binding object, that object exposes only the following four methods of the Binding object: getDataAsync, setDataAsync, addHandlerAsync, and removeHandlerAsync. If the promise cannot return a Binding object, the onError callback can be used to access an asyncResult.error object to get more information.If you need to call a member of the Binding object other than the four methods exposed by the Binding object promise returned by the select method, instead use the getByIdAsync method by using the Document.bindings property and Bindings.getByIdAsync method to retrieve the Binding object.

Example

The following code example uses the select method to retrieve a binding with the id " cities" from the Bindings collection, and then calls the addHandlerAsync method to add an event handler for the dataChanged event of the binding.

function addBindingDataChangedEventHandler() {
    Office.select("bindings#cities", function onError(){}).addHandlerAsync(Office.EventType.BindingDataChanged,
    function (eventArgs) {
        doSomethingWithBinding(eventArgs.binding);
    });
}

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.

Support history