Binding.removeHandlerAsync method (JavaScript API for Office)

apps for Office

Removes the specified handler from the binding for the specified event type.

Last modified: March 03, 2015

Hosts:

Access, Excel, Word

Available in Requirement set

BindingEvents

Last changed in

1.1

See all support details

bindingObj.removeHandlerAsync(eventType [, options], callback);

Name

Type

Description

Support notes

eventType

EventType

Specifies the type of event. Required.

options

object

Specifies any of the following optional parameters

handler

object

Specifies the name of the handler to remove.

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.

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

Property

Use to...

AsyncResult.value

Always returns undefined because there is no data or object to retrieve when removing an event handler.

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.

If the optional handler parameter is omitted when calling the removeHandlerAsync method, all event handlers for the specified eventType will be removed.

The following example removes the handler for the BindingDataChanged event named onBindingDataChanged.

function removeEventHandlerFromBinding() {
    Office.select("bindings#MyBinding").removeHandlerAsync(Office.EventType.BindingDataChanged, {handler:onBindingDataChanged});
}

A checkmark (√) 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 apps for Office.

Supported hosts, by platform

Office for Windows desktop

Office for Windows RT

Office Online
(in browser)

Access

Excel

Word

Available in requirement sets

BindingEvents

Minimum permission level

ReadWriteDocument

App types

Content, task pane

Library

Office.js

Namespace

Office

Version

Changes

1.1

Added support for apps for Access.

1.0

Introduced

Show:
© 2015 Microsoft