Office.SettingsChangedEventArgs interface

Пакет:

office

Предоставляет сведения о параметрах, вызвавших событие settingsChanged.

Чтобы добавить обработчик событий для события settingsChanged, используйте метод addHandlerAsync объекта Office.Settings .

Событие settingsChanged срабатывает, только если скрипт надстройки вызывает метод Settings.saveAsync для сохранения копии параметров в памяти в файле документа. Событие settingsChanged не вызывается при вызове методов Settings.set и Settings.remove.

Событие settingsChanged предназначено для обработки потенциальных конфликтов, когда два или более пользователей пытаются сохранить параметры одновременно, когда надстройка используется в общем (совместном) документе.

Важно! Код надстройки может зарегистрировать обработчик события settingsChanged, когда надстройка запущена с любым клиентом Excel, но это событие сработает только в том случае, если надстройка загружается с электронной таблицей, открытой в Excel в Интернете, и несколько пользователей редактируют электронную таблицу (совместное редактирование). Поэтому фактически событие settingsChanged поддерживается только в Excel в Интернете в сценариях совместного редактирования.

Свойства

settings	Возвращает объект Office.Settings , представляющий параметры, которые вызвали событие settingsChanged.
type	Получите значение перечисления Office.EventType , определяющее тип события, которое было создано.

Сведения о свойстве

settings

Возвращает объект Office.Settings , представляющий параметры, которые вызвали событие settingsChanged.

settings: Settings;

Значение свойства

Office.Settings

type

Получите значение перечисления Office.EventType , определяющее тип события, которое было создано.

type: EventType;

Значение свойства

Office.EventType