Office.SettingsChangedEventArgs interface
Предоставляет сведения о параметрах, вызвавших событие settingsChanged.
Чтобы добавить обработчик события settingsChanged, используйте метод addHandlerAsync объекта Office.Settings .
Событие settingsChanged возникает только в том случае, если сценарий надстройки вызывает метод Settings.saveAsync для сохранения копии параметров в памяти в файле документа. Событие settingsChanged не вызывается при вызове методов Settings.set и Settings.remove.
Событие settingsChanged предназначено для того, чтобы вы могли управлять потенциальными конфликтами, когда два или более пользователей одновременно пытаются сохранить параметры при одновременном использовании надстройки в общем (совместном) документе.
Важно! Код надстройки может зарегистрировать обработчик для события settingsChanged, когда надстройка выполняется в любом клиенте Excel, но это событие запускается только в том случае, если надстройка загружена с электронной таблицей, открытой в Excel в Интернете, и несколько пользователей редактируют электронную таблицу (совместно редактируя ее). Таким образом, фактически событие settingsChanged поддерживается только в Excel в Интернете в сценариях совместного редактирования.
Комментарии
Примеры
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 | Получает объект Office.Settings , представляющий параметры, которые вызвали событие settingsChanged. |
| type | Получите значение перечисления Office.EventType , определяющее тип возникшего события. |
Сведения о свойстве
settings
Получает объект Office.Settings , представляющий параметры, которые вызвали событие settingsChanged.
settings: Settings;Значение свойства
type
Получите значение перечисления Office.EventType , определяющее тип возникшего события.
type: EventType;