Excel.NamedItem class

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

readonly arrayValues: Excel.NamedItemArrayValues;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Especifica o comentário associado a este nome.

comment: string;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

A fórmula do item com nome. As fórmulas começam sempre com um sinal de igual ("=").

formula: any;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Exemplos

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

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    // Get the named item
    const 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}`);
    }
});

O nome do objeto.

readonly name: string;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Especifica se o nome está no âmbito do livro ou de uma folha de cálculo específica. Os valores possíveis são: Folha de Cálculo, Livro.

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

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

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

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

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 para Cadeia,Número Inteiro,Duplo,Booleano,Intervalo,Erro; 1,7 para Matriz ]

Representa o valor calculado pela fórmula do nome. Para um intervalo com nome, irá devolver o endereço do intervalo. Esta API devolve o #VALUE! na IU do Excel, se se referir a uma função definida pelo utilizador.

readonly value: any;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Uma representação JSON dos valores neste item com nome. Ao contrário NamedItem.valuede , NamedItem.valueAsJson suporta todos os tipos de dados que podem estar numa célula. Os exemplos incluem valores numéricos formatados e imagens Web, para além dos valores booleanos, numéricos e de cadeia padrão. Os dados devolvidos a partir desta API estão sempre alinhados com a região en-US. Para obter dados na região de apresentação do utilizador, utilize NamedItem.valueAsJsonLocal.

readonly valueAsJson: CellValue | string;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

Uma representação JSON dos valores neste item com nome. Ao contrário NamedItem.valuede , NamedItem.valueAsJsonLocal suporta todos os tipos de dados que podem estar numa célula. Os exemplos incluem valores numéricos formatados e imagens Web, para além dos valores booleanos, numéricos e de cadeia padrão. Os dados devolvidos a partir desta API estão sempre alinhados com a região de apresentação do utilizador. Para obter dados independentemente da região, utilize NamedItem.valueAsJson.

readonly valueAsJsonLocal: CellValue | string;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

Especifica se o objeto está visível.

visible: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Retorna a planilha em que o item nomeado tem escopo. Gera um erro se o item estiver no âmbito do livro.

readonly worksheet: Excel.Worksheet;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

Devolve a folha de cálculo na qual o item com nome está no âmbito. Se, em vez disso, o item estiver no âmbito do livro, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

readonly worksheetOrNullObject: Excel.Worksheet;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

Exclui o nome fornecido.

delete(): void;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

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) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const 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();
});

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

Comentários

[ Conjunto de API: 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);
});

Retorna o objeto Range associado ao nome. Se o tipo do item nomeado não for um intervalo, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

getRangeOrNullObject(): Excel.Range;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

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

Retornos

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

Retornos

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);
});

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

Retornos

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

Retornos

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

set(properties: Excel.NamedItem): void;

Parâmetros

Retornos

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.NamedItem é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.NamedItemData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.NamedItemData;

Retornos