Office.SaveSettingsOptions interface

Paquet:
office

Fournit des options pour enregistrer les paramètres.

Remarques

Utilisateur

Exemples

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

Propriétés

asyncContext

Élément défini par l’utilisateur de n’importe quel type qui est retourné, inchangé, dans la propriété asyncContext de l’objet AsyncResult qui est transmis à un rappel.
overwriteIfStale

Avertissement : ce paramètre a été déconseillé et ne doit pas être utilisé. Il n’a aucun effet sur la plupart des plateformes et provoquera des erreurs s’il false est défini sur Excel sur le Web.

Détails de la propriété

asyncContext

Élément défini par l’utilisateur de n’importe quel type qui est retourné, inchangé, dans la propriété asyncContext de l’objet AsyncResult qui est transmis à un rappel.

asyncContext?: any

Valeur de propriété

any

overwriteIfStale

Avertissement

Cette API est à présent déconseillée.

overwriteIfStale is no longer supported.

Avertissement : ce paramètre a été déconseillé et ne doit pas être utilisé. Il n’a aucun effet sur la plupart des plateformes et provoquera des erreurs s’il false est défini sur Excel sur le Web.

overwriteIfStale?: boolean

Valeur de propriété

boolean