Excel.NamedItem interface

Representa um nome definido para um intervalo de células ou um valor. Os nomes podem ser objetos com nome primitivo (como visto no tipo abaixo), um objeto Range ou uma referência a um intervalo. Use esse objeto para obter um objeto de intervalo associado aos nomes.

Propriedades

arrayValues

Retorna um objeto que contém valores e tipos do item nomeado.

comment

Especifica o comentário associado a esse nome.

formula

A fórmula do item nomeado. A fórmula sempre começa com um sinal de "=".

name

O nome do objeto.

scope

Especifica se o nome tem como escopo a pasta de trabalho ou uma planilha específica. Os valores possíveis são: planilha, pasta de trabalho.

type

Especifica o tipo do valor retornado pela fórmula do nome. Consulte Excel. NamedItemType para obter detalhes.

value

Representa o valor calculado pela fórmula do nome. Para um intervalo nomeado, retornará o endereço do intervalo.

visible

Especifica se o objeto está visível.

worksheet

Retorna a planilha em que o item nomeado tem escopo. Gera um erro se o item estiver no escopo da pasta de trabalho.

worksheetOrNullObject

Retorna a planilha em que o item nomeado tem escopo. Retornará um objeto null se o item tiver escopo para a pasta de trabalho em vez disso.

Métodos

delete()

Exclui o nome fornecido.

getRange()

Retorna o objeto Range associado ao nome. Gerará um erro se o tipo do item nomeado não for um intervalo.

getRangeOrNullObject()

Retorna o objeto Range associado ao nome. Retornará um objeto null se o tipo do item nomeado não for um intervalo.

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

arrayValues

Retorna um objeto que contém valores e tipos do item nomeado.

readonly arrayValues: NamedItemArrayValues;

Valor da propriedade

comment

Especifica o comentário associado a esse nome.

comment: string;

Valor da propriedade

string

formula

A fórmula do item nomeado. A fórmula sempre começa com um sinal de "=".

formula: any;

Valor da propriedade

any

Exemplos

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

    // Get the named item
    let myNamedItem = sheet.names.getItemOrNullObject("MyRange");
    myNamedItem.load("name, formula");
    await context.sync();

    if (myNamedItem.isNullObject) {
        console.log(`There is no named item. Create it with "Add named item for a range" first.`);
    } else {                    
        // Update named item to point to the second range
        myNamedItem.formula = "=Sample!$B$10:$D$14";
        sheet.getRange("B10:D14").select();
        await context.sync();

        console.log(`Just updated the named item "${myNamedItem.name}" -- it's now located here: ${myNamedItem.formula}`);
    }
}

name

O nome do objeto.

readonly name: string;

Valor da propriedade

string

scope

Especifica se o nome tem como escopo a pasta de trabalho ou uma planilha específica. Os valores possíveis são: planilha, pasta de trabalho.

readonly scope: NamedItemScope | "Worksheet" | "Workbook";

Valor da propriedade

NamedItemScope | "Worksheet" | "Workbook"

type

Especifica o tipo do valor retornado pela fórmula do nome. Consulte Excel. NamedItemType para obter detalhes.

readonly type:
            | NamedItemType
            | "String"
            | "Integer"
            | "Double"
            | "Boolean"
            | "Range"
            | "Error"
            | "Array";

Valor da propriedade

| NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array"

value

Representa o valor calculado pela fórmula do nome. Para um intervalo nomeado, retornará o endereço do intervalo.

readonly value: any;

Valor da propriedade

any

visible

Especifica se o objeto está visível.

visible: boolean;

Valor da propriedade

boolean

worksheet

Retorna a planilha em que o item nomeado tem escopo. Gera um erro se o item estiver no escopo da pasta de trabalho.

readonly worksheet: Worksheet;

Valor da propriedade

worksheetOrNullObject

Retorna a planilha em que o item nomeado tem escopo. Retornará um objeto null se o item tiver escopo para a pasta de trabalho em vez disso.

readonly worksheetOrNullObject: Worksheet;

Valor da propriedade

Detalhes do método

delete()

Exclui o nome fornecido.

delete(): void;

Retornos

void

Exemplos

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let totalName = sheet.names.getItemOrNullObject("TotalAmount");
    totalName.load();
    await context.sync();

    if (totalName.value) {
        totalName.delete();

        // Replace the named item (TotalAmount) with the actual formula for TotalAmount to avoid displaying #NAME in the cell.
        sheet.getRange("D11").values = [["=SUM(ExpensesTable[AMOUNT])"]];
    } else {
        console.log("No named item created for the formula.");
    }

    await context.sync();
}

getRange()

Retorna o objeto Range associado ao nome. Gerará um erro se o tipo do item nomeado não for um intervalo.

getRange(): Range;

Retornos

getRangeOrNullObject()

Retorna o objeto Range associado ao nome. Retornará um objeto null se o tipo do item nomeado não for um intervalo.

getRangeOrNullObject(): Range;

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