Excel.Setting interface

A configuração representa um par chave-valor de uma configuração persistente para o documento (por arquivo por suplemento). Esse par chave-valor personalizado pode ser usado para armazenar informações de estado ou de ciclo de vida necessárias para o conteúdo ou suplemento de painel de tarefas. Observe que as configurações são mantidas no documento e, portanto, não é um local para armazenar informações confidenciais ou protegidas, como informações de usuário e senha.

Propriedades

key

A chave que representa a ID da configuração.

value

Representa o valor armazenado para esta configuração.

Métodos

delete()

Exclui a configuração.

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

Detalhes da propriedade

key

A chave que representa a ID da configuração.

readonly key: string;

Valor da propriedade

string

value

Representa o valor armazenado para esta configuração.

value: any;

Valor da propriedade

any

Detalhes do método

delete()

Exclui a configuração.

delete(): void;

Retornos

void

Exemplos

async function main(context: Excel.RequestContext) {
    let settings = context.workbook.settings;
    let needsReview = settings.getItem("NeedsReview");
    needsReview.delete();
    needsReview = settings.getItemOrNullObject("NeedsReview");

    await context.sync();

    if (needsReview.isNullObject) {
        console.log("The setting has been deleted");
    } else {
        console.log("The setting was not deleted");
    }

    await context.sync();
}

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): void;

Parâmetros

propertyNames
string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

void