Settings.settingsChanged event (JavaScript API for Office v1.1)

JavaScript API for Office v1.1

Occurs when the in-memory copy of the settings property bag is saved into the document with the Settings.saveAsync method.

Last modified: June 12, 2014

Office.EventType.SettingsChanged

To add an event handler for the settingsChanged event, use the addHandlerAsync method of the Settings object.

The settingsChanged event fires only when your app's script calls the Settings.saveAsync method to persist the in-memory copy of the settings into the document file. The settingsChanged event is not triggered when the Settings.set or Settings.remove methods are called.

The settingsChanged event was designed to let you to handle potential conflicts when two or more users are attempting to save settings at the same time when your app is used in a shared (co-authored) document.

Important note Important

Your app's code can register a handler for the settingsChanged event in 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). Therefore, effectively the settingsChanged event is supported only in Excel Online in co-authoring scenarios.

App types

Content apps, Task pane apps

Supported clients

Excel 2013, Excel Online, Excel 2013 SP1, Excel 2013 RT, Word 2013, Word 2013 SP1, Word 2013 RT, PowerPoint 2013PowerPoint 2013 SP1, PowerPoint 2013 RT

Library

Office.js

Namespace

Office

Show:
© 2014 Microsoft