Office.SaveSettingsOptions interface

Paket:
office

Bietet Optionen zum Speichern von Einstellungen.

Hinweise

Verwendet von

Beispiele

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);
        }
    });
}

Eigenschaften

asyncContext

Ein benutzerdefiniertes Element eines beliebigen Typs, das unverändert in der asyncContext-Eigenschaft des AsyncResult-Objekts zurückgegeben wird, das an einen Rückruf übergeben wird.
overwriteIfStale

Warnung: Diese Einstellung ist veraltet und sollte nicht verwendet werden. Es hat keine Auswirkungen auf die meisten Plattformen und verursacht Fehler, wenn es auf in Excel im Web festgelegt false ist.

Details zur Eigenschaft

asyncContext

Ein benutzerdefiniertes Element eines beliebigen Typs, das unverändert in der asyncContext-Eigenschaft des AsyncResult-Objekts zurückgegeben wird, das an einen Rückruf übergeben wird.

asyncContext?: any

Eigenschaftswert

any

overwriteIfStale

Warnung

Diese API ist nun veraltet.

overwriteIfStale is no longer supported.

Warnung: Diese Einstellung ist veraltet und sollte nicht verwendet werden. Es hat keine Auswirkungen auf die meisten Plattformen und verursacht Fehler, wenn es auf in Excel im Web festgelegt false ist.

overwriteIfStale?: boolean

Eigenschaftswert

boolean