Docs API Reference

Document.removeHandlerAsync method

Removes an event handler for a Document object event.

Hosts: Excel, PowerPoint, Project, Word
Available in Requirement set DocumentEvents
Added in 1.1
Office.context.document.removeHandlerAsync(eventType [, options], callback);

Parameters

Name Type Description Support notes
eventType EventType Specifies the type of event to remove. 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.

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 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 object or data to retrieve.
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

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

Example

The following example removes the event handler named 'MyHandler'.

function removeSelectionChangedEventHandler() {
    Office.context.document.removeHandlerAsync(Office.EventType.DocumentSelectionChanged, {handler:MyHandler});
}

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.

Supported hosts, by platform

Office for Windows desktop Office Online (in browser) Office for iPad
Excel Y Y Y
PowerPoint Y Y Y
Project
Word Y Y Y
Available in requirement sets DocumentEvents
Minimum permission level ReadWriteDocument
Add-in types Content, task pane
Library Office.js
Namespace Office

Support history


Version Changes
1.1 Added support for Excel, PowerPoint, and Word in Office for iPad.
1.1 Introduced.