Excel.SettingCollection interface

Representa uma coleção de objetos de configuração de pares chave-valor que fazem parte da pasta de trabalho. O escopo está limitado por arquivo e suplemento (a combinação de painel de tarefas ou conteúdo).

Métodos

add(key, value)

Define na pasta de trabalho ou adiciona a ela a configuração especificada.

getCount()

Obtém o número de Configurações na coleção.

getItem(key)

Obtém uma entrada de configuração por meio da tecla.

getItemOrNullObject(key)

Obtém uma entrada de configuração por meio da tecla. Se a Configuração não existir, retornará um objeto null.

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 do método

add(key, value)

Define na pasta de trabalho ou adiciona a ela a configuração especificada.

add(
            key: string,
            value: string | number | boolean | Date | Array<any> | any
        ): Setting;

Parâmetros

key
string

A chave da nova configuração.

value
string | number | boolean | Date | Array<any> | any

O valor da nova configuração.

Retornos

getCount()

Obtém o número de Configurações na coleção.

getCount(): ClientResult<number>;

Retornos

ClientResult<number>

getItem(key)

Obtém uma entrada de configuração por meio da tecla.

getItem(key: string): Setting;

Parâmetros

key
string

Chave da configuração.

Retornos

getItemOrNullObject(key)

Obtém uma entrada de configuração por meio da tecla. Se a Configuração não existir, retornará um objeto null.

getItemOrNullObject(key: string): Setting;

Parâmetros

key
string

A chave da configuração.

Retornos

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