Excel.Interfaces.NamedItemLoadOptions interface

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.

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Propiedades

$all

$all Al especificar para las opciones de carga, se cargan todas las propiedades escalares (comoRange.address ), pero no las propiedades de navegación (como Range.format.fill.color).

arrayValues

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

comment

Especifica el comentario asociado a este nombre.

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).

Detalles de las propiedades

$all

$all Al especificar para las opciones de carga, se cargan todas las propiedades escalares (comoRange.address ), pero no las propiedades de navegación (como Range.format.fill.color).

$all?: boolean;

Valor de propiedad

boolean

arrayValues

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

arrayValues?: Excel.Interfaces.NamedItemArrayValuesLoadOptions;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

comment

Especifica el comentario asociado a este nombre.

comment?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

formula

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

formula?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

name

Nombre del objeto.

name?: boolean;

Valor de propiedad

boolean

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.

scope?: boolean;

Valor de propiedad

boolean

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.

type?: boolean;

Valor de propiedad

boolean

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.

value?: boolean;

Valor de propiedad

boolean

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.

valueAsJson?: boolean;

Valor de propiedad

boolean

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.

valueAsJsonLocal?: boolean;

Valor de propiedad

boolean

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.

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Valor de propiedad

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).

worksheetOrNullObject?: Excel.Interfaces.WorksheetLoadOptions;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]