Settings.addHandlerAsync method (JavaScript API for Office v1.0)

Adds an event handler for the settingsChanged event.

Last modified: June 12, 2014

Office.context.document.settings.addHandlerAsync(eventType, handler [, options], callback);

eventType

Type: EventType

Specifies the type of event to add. Required.

handler

Type: object

The event handler function to add. Required.

options

Type:object

Specifies the following optional parameters.

asyncContext

Type: 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. Optional.

callback

Type: 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 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.

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

Important note Important

You can register a handler for the settingsChanged event in Word or Excel, but the event will only fire when a task pane or content app created for Excel is loaded with a spreadsheet that is opened in Excel Online, and more than one user is working with the spreadsheet (co-authoring).

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

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

// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

Supported clients

Excel 2013, Excel 2013 RT, Excel Online, Word 2013, Word 2013 RT, and PowerPoint 2013, PowerPoint 2013 RT

Library

Office.js

Namespace

Office

Show:
© 2015 Microsoft