Office.SettingsChangedEventArgs interface

提供有关引发了 settingsChanged 事件的设置的信息。

若要为 settingsChanged 事件添加事件处理程序,请使用 Office.Settings 对象的 addHandlerAsync 方法。

仅当外接程序的脚本调用 Settings.saveAsync 方法以将设置的内存中副本保存到文档文件时,才会触发 settingsChanged 事件。 调用 Settings.set 或 Settings.remove 方法时,不会触发 settingsChanged 事件。

settingsChanged 事件旨在让你在两个或更多用户尝试保存设置时同时在共享 (共同创作的) 文档中保存设置时处理潜在的冲突。

重要提示:当外接程序与任何 Excel 客户端一起运行时,外接程序的代码可以为 settingsChanged 事件注册处理程序,但仅当加载项加载了在 Excel 网页版中打开的电子表格,并且多个用户正在编辑电子表格 (共同创作) 时,才会触发该事件。 因此,实际上,在共同创作方案中,只有在 Excel 网页版中才支持 settingsChanged 事件。

属性

settings

获取一个 Office.Settings 对象,该对象表示引发 settingsChanged 事件的设置。

type

获取一个 Office.EventType 枚举值,该值标识引发的事件类型。

属性详细信息

settings

获取一个 Office.Settings 对象,该对象表示引发 settingsChanged 事件的设置。

settings: Settings;

属性值

type

获取一个 Office.EventType 枚举值,该值标识引发的事件类型。

type: EventType;

属性值