Export (0) Print
Expand All

Settings.addHandlerAsync method

Adds an event handler for the settingsChanged event.

Last modified: June 12, 2014

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


Type: EventType

Specifies the type of event to add. Required.


Type: object

The event handler function to add. Required.



Specifies the following optional parameters.


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.


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.


Use to...


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


Determine the success or failure of the operation.


Access an Error object that provides error information if the operation failed.


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

In version 1.1 of Office.js, you can add and remove event handlers for the SettingsChanged event in content apps for Access.

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

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

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

App types

Content apps, Task pane apps

Supported clients

Access app for SharePoint, Excel 2013, Excel Online, Excel 2013 SP1, Excel 2013 RT, Word 2013, Word 2013 SP1, Word 2013 RT, PowerPoint 2013, PowerPoint 2013 SP1, PowerPoint 2013 RT





© 2015 Microsoft