Excel.NamedItem class

  • Referencia
Paquete:
excel

Representa un nombre definido para un rango de celdas o un valor. Los nombres pueden ser objetos con nombre primitivos (como se muestra en el tipo siguiente), objeto de rango o una referencia a un rango. Este objeto puede usarse para obtener un objeto de rango asociado a nombres.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

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

Propiedades

arrayValues

Devuelve un objeto que contiene los valores y tipos del elemento con nombre.
comment

Especifica el comentario asociado a este nombre.
context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
formula

Fórmula del elemento con nombre. Las fórmulas siempre comienzan con un signo igual ("=").
name

Nombre del objeto.
scope

Especifica si el nombre se limita al libro o a una hoja de cálculo específica. Los valores posibles son: Worksheet, Workbook.
type

Especifica el tipo del valor devuelto por la fórmula del nombre. Vea Excel.NamedItemType para más información.
value

Representa el valor calculado por la fórmula del nombre. Para un intervalo con nombre, devolverá la dirección del intervalo. Esta API devuelve el #VALUE! error en la interfaz de usuario de Excel si hace referencia a una función definida por el usuario.
valueAsJson

Representación JSON de los valores de este elemento con nombre. A diferencia de NamedItem.value, NamedItem.valueAsJson admite todos los tipos de datos que pueden estar en una celda. Entre los ejemplos se incluyen valores de número con formato e imágenes web, además de los valores booleanos, numéricos y de cadena estándar. Los datos devueltos desde esta API siempre se alinean con la configuración regional en-US. Para recuperar datos en la configuración regional de visualización del usuario, use NamedItem.valueAsJsonLocal.
valueAsJsonLocal

Representación JSON de los valores de este elemento con nombre. A diferencia de NamedItem.value, NamedItem.valueAsJsonLocal admite todos los tipos de datos que pueden estar en una celda. Entre los ejemplos se incluyen valores de número con formato e imágenes web, además de los valores booleanos, numéricos y de cadena estándar. Los datos devueltos desde esta API siempre se alinean con la configuración regional de visualización del usuario. Para recuperar datos independientes de la configuración regional, use NamedItem.valueAsJson.
visible

Especifica si el objeto está visible.
worksheet

Devuelve la hoja de cálculo que tiene como ámbito el elemento con nombre. Produce un error si el elemento tiene el ámbito del libro en su lugar.
worksheetOrNullObject

Devuelve la hoja de cálculo a la que se limita el elemento con nombre. Si el elemento se limita al libro en su lugar, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

Métodos

delete()

Elimina el nombre especificado.
getRange()

Devuelve el objeto de rango asociado al nombre. Se produce un error si el tipo del elemento con nombre no es un rango.
getRangeOrNullObject()

Devuelve el objeto de rango asociado al nombre. Si el tipo del elemento con nombre no es un intervalo, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
set(properties, options)

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.
set(properties)

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto Excel.NamedItem original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.NamedItemData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

arrayValues

Devuelve un objeto que contiene los valores y tipos del elemento con nombre.

readonly arrayValues: Excel.NamedItemArrayValues;

Valor de propiedad

Excel.NamedItemArrayValues

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

comment

Especifica el comentario asociado a este nombre.

comment: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Excel.RequestContext

formula

Fórmula del elemento con nombre. Las fórmulas siempre comienzan con un signo igual ("=").

formula: any;

Valor de propiedad

any

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

Ejemplos

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

name

Nombre del objeto.

readonly name: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

scope

Especifica si el nombre se limita al libro o a una hoja de cálculo específica. Los valores posibles son: Worksheet, Workbook.

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

Valor de propiedad

Excel.NamedItemScope | "Worksheet" | "Workbook"

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

type

Especifica el tipo del valor devuelto por la fórmula del nombre. Vea Excel.NamedItemType para más información.

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

Valor de propiedad

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

Comentarios

[ Conjunto de API: ExcelApi 1.1 for String,Integer,Double,Boolean,Range,Error; 1.7 for Array ]

value

Representa el valor calculado por la fórmula del nombre. Para un intervalo con nombre, devolverá la dirección del intervalo. Esta API devuelve el #VALUE! error en la interfaz de usuario de Excel si hace referencia a una función definida por el usuario.

readonly value: any;

Valor de propiedad

any

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

valueAsJson

Representación JSON de los valores de este elemento con nombre. A diferencia de NamedItem.value, NamedItem.valueAsJson admite todos los tipos de datos que pueden estar en una celda. Entre los ejemplos se incluyen valores de número con formato e imágenes web, además de los valores booleanos, numéricos y de cadena estándar. Los datos devueltos desde esta API siempre se alinean con la configuración regional en-US. Para recuperar datos en la configuración regional de visualización del usuario, use NamedItem.valueAsJsonLocal.

readonly valueAsJson: CellValue | string;

Valor de propiedad

Excel.CellValue | string

Comentarios

[ Conjunto de API: ExcelApi 1.16 ]

valueAsJsonLocal

Representación JSON de los valores de este elemento con nombre. A diferencia de NamedItem.value, NamedItem.valueAsJsonLocal admite todos los tipos de datos que pueden estar en una celda. Entre los ejemplos se incluyen valores de número con formato e imágenes web, además de los valores booleanos, numéricos y de cadena estándar. Los datos devueltos desde esta API siempre se alinean con la configuración regional de visualización del usuario. Para recuperar datos independientes de la configuración regional, use NamedItem.valueAsJson.

readonly valueAsJsonLocal: CellValue | string;

Valor de propiedad

Excel.CellValue | string

Comentarios

[ Conjunto de API: ExcelApi 1.16 ]

visible

Especifica si el objeto está visible.

visible: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

worksheet

Devuelve la hoja de cálculo que tiene como ámbito el elemento con nombre. Produce un error si el elemento tiene el ámbito del libro en su lugar.

readonly worksheet: Excel.Worksheet;

Valor de propiedad

Excel.Worksheet

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

worksheetOrNullObject

Devuelve la hoja de cálculo a la que se limita el elemento con nombre. Si el elemento se limita al libro en su lugar, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

readonly worksheetOrNullObject: Excel.Worksheet;

Valor de propiedad

Excel.Worksheet

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

Detalles del método

delete()

Elimina el nombre especificado.

delete(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

Ejemplos

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

getRange()

Devuelve el objeto de rango asociado al nombre. Se produce un error si el tipo del elemento con nombre no es un rango.

getRange(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

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

getRangeOrNullObject()

Devuelve el objeto de rango asociado al nombre. Si el tipo del elemento con nombre no es un intervalo, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getRangeOrNullObject(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

options
Excel.Interfaces.NamedItemLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Excel.NamedItem

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNames?: string | string[]): Excel.NamedItem;

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Excel.NamedItem

Ejemplos

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)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Excel.NamedItem

set(properties, options)

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.

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

Parámetros

properties
Excel.Interfaces.NamedItemUpdateData

Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.

options
OfficeExtension.UpdateOptions

Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.

Devoluciones

void

set(properties)

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: Excel.NamedItem): void;

Parámetros

properties
Excel.NamedItem

Devoluciones

void

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto Excel.NamedItem original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.NamedItemData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.NamedItemData;

Devoluciones

Excel.Interfaces.NamedItemData