Excel.NamedItemCollection interface

Uma coleção de todos os objetos NamedItem que fazem parte da pasta de trabalho ou planilha, dependendo de como ela foi atingida.

Métodos

add(name, reference, comment)

Adiciona um novo nome à coleção do escopo fornecido.

addFormulaLocal(name, formula, comment)

Adiciona um novo nome à coleção de escopo fornecido usando a localidade do usuário para a fórmula.

getCount()

Obtém o número de itens nomeados na coleção.

getItem(name)

Obtém um objeto NamedItem usando seu nome.

getItemOrNullObject(name)

Obtém um objeto NamedItem usando seu nome. Se o objeto getNamedItem 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(name, reference, comment)

Adiciona um novo nome à coleção do escopo fornecido.

add(
            name: string,
            reference: Range | string,
            comment?: string
        ): NamedItem;

Parâmetros

name
string

O nome do item nomeado.

reference
Range | string

A fórmula ou o intervalo ao qual o nome fará referência.

comment
string

Opcional. O comentário associado ao item nomeado.

Retornos

Exemplos

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let headerRange = sheet.getRange("A1:D1");

    sheet.names.add("ExpensesHeader", headerRange);
    let namedItems = sheet.names.load("name, type");

    await context.sync();
}

addFormulaLocal(name, formula, comment)

Adiciona um novo nome à coleção de escopo fornecido usando a localidade do usuário para a fórmula.

addFormulaLocal(
            name: string,
            formula: string,
            comment?: string
        ): NamedItem;

Parâmetros

name
string

O "nome" do item nomeado.

formula
string

A fórmula na localidade do usuário à qual o nome se referirá.

comment
string

Opcional. O comentário associado ao item nomeado.

Retornos

getCount()

Obtém o número de itens nomeados na coleção.

getCount(): ClientResult<number>;

Retornos

ClientResult<number>

getItem(name)

Obtém um objeto NamedItem usando seu nome.

getItem(name: string): NamedItem;

Parâmetros

name
string

NamedItem Name.

Retornos

getItemOrNullObject(name)

Obtém um objeto NamedItem usando seu nome. Se o objeto getNamedItem não existir, retornará um objeto null.

getItemOrNullObject(name: string): NamedItem;

Parâmetros

name
string

NamedItem Name.

Retornos

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