Office.SaveSettingsOptions interface

Пакет:
office

Предоставляет параметры для сохранения параметров.

Комментарии

Используется

Примеры

function persistSettingsWithContext() {
    Office.context.document.settings.set('reportFormat', 'pdf');

    const options: Office.SaveSettingsOptions = {
        asyncContext: { settingName: 'reportFormat' }
    };

    Office.context.document.settings.saveAsync(options, function (asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.log(asyncResult.error.message);
        } else {
            console.log('Saved setting: ' + asyncResult.asyncContext.settingName);
        }
    });
}

Свойства

asyncContext

Определяемый пользователем элемент любого типа, возвращаемый без изменений в свойстве asyncContext объекта AsyncResult, который передается обратному вызову.
overwriteIfStale

Предупреждение. Этот параметр устарел и не должен использоваться. Это не влияет на большинство платформ и вызывает ошибки, если в Excel в Интернете задано значение false .

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

asyncContext

Определяемый пользователем элемент любого типа, возвращаемый без изменений в свойстве asyncContext объекта AsyncResult, который передается обратному вызову.

asyncContext?: any

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

any

overwriteIfStale

Предупреждение

Теперь этот API является нерекомендуемым.

overwriteIfStale is no longer supported.

Предупреждение. Этот параметр устарел и не должен использоваться. Это не влияет на большинство платформ и вызывает ошибки, если в Excel в Интернете задано значение false .

overwriteIfStale?: boolean

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

boolean