Settings.addHandlerAsync method

Adds an event handler for the settingsChanged event.


Hosts:	Excel
Available in Requirement set	Settings
Last changed in	1.0

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

Parameters

Name	Type	Description
eventType	EventType	Specifies the type of event to add. Required.
handler	object	The event handler function to add. 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.

Important: Your add-in's code can register a handler for the settingsChanged event when the add-in is running with any Excel client, but the event will fire only when the add-in is loaded with a spreadsheet that is opened in Excel Online, and more than one user is editing the spreadsheet (co-authoring). Therefore, effectively the settingsChanged event is supported only in Excel Online in co-authoring scenarios.

Example

function addSelectionChangedEventHandler() {
    Office.context.document.settings.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; 
}

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.

	Office for Windows desktop	Office Online (in browser)	Office for iPad
Excel		Y


Available in requirement sets	Settings
Minimum permission level	ReadWriteDocument
Add-in types	Content, task pane
Library	Office.js
Namespace	Office

Support history

Version	Changes
1.0	Introduced

Docs