Excel.NamedItem class

Pacote:
excel

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

Extends
OfficeExtension.ClientObject

Comentários

Conjunto de APIs: ExcelApi 1.1

Usada por

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/34-named-item/create-and-remove-named-item.yaml

await Excel.run(async (context) => {
    // Log all the named items in the active worksheet.
    const namedItems = context.workbook.worksheets.getActiveWorksheet().names.load();
    await context.sync();

    console.log("This worksheet contains " + namedItems.items.length + " named items.");

    for (let i = 0; i < namedItems.items.length; i++) {
        const namedItem : Excel.NamedItem = namedItems.items[i];
        console.log(JSON.stringify(namedItem)) + "\n";
    }

    await context.sync();
});

Propriedades

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
name

O nome do objeto.
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, ele retornará o endereço do intervalo. Essa API retorna o #VALUE! na interface do usuário do Excel se ele se referir a uma função definida pelo usuário.
visible

Especifica se o objeto é visível.

Métodos

getRange()

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

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
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(propertyNamesAndPaths)

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

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.NamedItem é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.NamedItemData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

Detalhes da propriedade

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

name

O nome do objeto.

readonly name: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: ExcelApi 1.1

type

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

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

Valor da propriedade

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

Comentários

Conjunto de APIs: ExcelApi 1.1 para String,Integer,Double,Boolean,Range,Error; 1.7 para matriz

value

Representa o valor calculado pela fórmula do nome. Para um intervalo nomeado, ele retornará o endereço do intervalo. Essa API retorna o #VALUE! na interface do usuário do Excel se ele se referir a uma função definida pelo usuário.

readonly value: any;

Valor da propriedade

any

Comentários

Conjunto de APIs: ExcelApi 1.1

visible

Especifica se o objeto é visível.

visible: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.1

Detalhes do método

getRange()

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

getRange(): Excel.Range;

Retornos

Excel.Range

Comentários

Conjunto de APIs: ExcelApi 1.1

Exemplos

// Returns the Range object that is associated with the name.
// Returns `null` if the name is not of type Range.
// Note: This API currently supports only the Workbook scoped items.
await Excel.run(async (context) => { 
    const names = context.workbook.names;
    const range = names.getItem('MyRange').getRange();
    range.load('address');
    await context.sync();

    console.log(range.address);
});

load(options)

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

load(options?: Excel.Interfaces.NamedItemLoadOptions): Excel.NamedItem;

Parâmetros

options
Excel.Interfaces.NamedItemLoadOptions

Fornece opções para quais propriedades do objeto devem ser carregadas.

Retornos

Excel.NamedItem

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[]): Excel.NamedItem;

Parâmetros

propertyNames

string | string[]

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

Retornos

Excel.NamedItem

Exemplos

await Excel.run(async (context) => { 
    const names = context.workbook.names;
    const namedItem = names.getItem('MyRange');
    namedItem.load('type');
    await context.sync();
    
    console.log(namedItem.type);
});

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.NamedItem;

Parâmetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.

Retornos

Excel.NamedItem

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.NamedItemUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties
Excel.Interfaces.NamedItemUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Excel.NamedItem): void;

Parâmetros

properties
Excel.NamedItem

Retornos

void

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.NamedItem é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.NamedItemData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.NamedItemData;

Retornos

Excel.Interfaces.NamedItemData