Document.addHandlerAsync method

Adds 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.addHandlerAsync(eventType, handler  [, options], callback);

Parameters

Name Type Description Support notes
eventType EventType For a Document object event, the eventType parameter can be specified as Office.EventType.DocumentSelectionChanged, or the corresponding text value of this enumeration.
handler object The event handler function to add, whose only parameter is of type DocumentSelectionChangedEventArgs. Required.
options object Specifies any of the following optional parameters:
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 addHandlerAsync 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 adding 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.

Remarks

You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.

Example

function addSelectionChangedEventHandler() {
    Office.context.document.addHandlerAsync(Office.EventType.DocumentSelectionChanged, MyHandler);
}

function MyHandler(eventArgs) {
    write('Event raised: ' + eventArgs.type);
    doSomethingWithDocument(eventArgs.document);
}

// 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.

Supported hosts, by platform

Office for Windows desktop Office Online (in browser) Office for iPad
Excel Y Y Y
PowerPoint Y Y Y
Project Y
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.0 Introduced