Office.SettingsChangedEventArgs interface
提供有关引发了 settingsChanged 事件的设置的信息。
若要为 settingsChanged 事件添加事件处理程序，请使用 Office.Settings 对象的 addHandlerAsync 方法。
仅当加载项的脚本调用 Settings.saveAsync 方法以将设置的内存内副本保存到文档文件中时，才会触发 settingsChanged 事件。 调用 Settings.set 或 Settings.remove 方法时，不会触发 settingsChanged 事件。
settingsChanged 事件旨在当在共享 (共同创作的) 文档中使用你的加载项时，当两个或更多用户尝试同时保存设置时，你能够处理潜在的冲突。
重要提示： 当加载项使用任何 Excel 客户端运行时，加载项的代码可以为 settingsChanged 事件注册处理程序，但是仅当加载项包含以 Excel web 版 打开的电子表格，并且多个用户正在编辑电子表格 (共同创作) 时，才会触发此事件。 因此，实际上，只有共同创作方案中的 Excel web 版才支持 settingsChanged 事件。
注解
示例
function addSelectionChangedEventHandler() {
Office.context.document.settings.addHandlerAsync(Office.EventType.SettingsChanged, MyHandler);
}
function MyHandler(eventArgs: Office.SettingsChangedEventArgs) {
console.log('Event raised: ' + eventArgs.type);
doSomethingWithSettings(eventArgs.settings);
}
属性
| settings | 获取表示引发 settingsChanged 事件的设置的 Office.Settings 对象。 |
| type | 获取标识引发的事件类型的 Office.EventType 枚举值。 |