Compartilhar via

Office.SaveSettingsOptions interface

Pacote:
office

Fornece opções para guardar definições.

Comentários

Exemplos

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

Propriedades

asyncContext

Um item definido pelo utilizador de qualquer tipo que seja devolvido, inalterado, na propriedade asyncContext do objeto AsyncResult que é transmitido a uma chamada de retorno.
overwriteIfStale

Aviso: esta definição foi preterida e não deve ser utilizada. Não tem qualquer efeito na maioria das plataformas e causará erros se estiver definido como false no Excel na Web.

Detalhes da propriedade

asyncContext

Um item definido pelo utilizador de qualquer tipo que seja devolvido, inalterado, na propriedade asyncContext do objeto AsyncResult que é transmitido a uma chamada de retorno.

asyncContext?: any

Valor da propriedade

any

overwriteIfStale

Aviso

Essa API foi preterida.

overwriteIfStale is no longer supported.

Aviso: esta definição foi preterida e não deve ser utilizada. Não tem qualquer efeito na maioria das plataformas e causará erros se estiver definido como false no Excel na Web.

overwriteIfStale?: boolean

Valor da propriedade

boolean