Excel.Interfaces.NamedItemCollectionLoadOptions interface

Colección de todos los NamedItem objetos que forman parte del libro o la hoja de cálculo, en función de cómo se haya alcanzado.

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

Para CADA ELEMENTO de la colección: devuelve un objeto que contiene valores y tipos del elemento con nombre.

comment

Para CADA ELEMENTO de la colección: especifica el comentario asociado a este nombre.

formula

Para CADA ELEMENTO de la colección: la fórmula del elemento con nombre. Las fórmulas siempre comienzan con un signo igual ("=").

name

Para CADA ELEMENTO de la colección: nombre del objeto.

scope

Para CADA ELEMENTO de la colección: especifica si el nombre está limitado al libro o a una hoja de cálculo específica. Los valores posibles son: Worksheet, Workbook.

type

Para CADA ELEMENTO de la colección: especifica el tipo del valor devuelto por la fórmula del nombre. Vea Excel.NamedItemType para más información.

value

Para CADA ELEMENTO de la colección: 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

Para CADA ELEMENTO de la colección: 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

Para CADA ELEMENTO de la colección: 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

Para CADA ELEMENTO de la colección: especifica si el objeto está visible.

worksheet

Para CADA ELEMENTO de la colección: devuelve la hoja de cálculo a la que se limita el elemento con nombre. Produce un error si el elemento tiene el ámbito del libro en su lugar.

worksheetOrNullObject

Para CADA ELEMENTO de la colección: 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

Para CADA ELEMENTO de la colección: devuelve un objeto que contiene valores y tipos del elemento con nombre.

arrayValues?: Excel.Interfaces.NamedItemArrayValuesLoadOptions;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

comment

Para CADA ELEMENTO de la colección: especifica el comentario asociado a este nombre.

comment?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

formula

Para CADA ELEMENTO de la colección: la 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

Para CADA ELEMENTO de la colección: nombre del objeto.

name?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

scope

Para CADA ELEMENTO de la colección: especifica si el nombre está limitado 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

Para CADA ELEMENTO de la colección: 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

Para CADA ELEMENTO de la colección: 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

Para CADA ELEMENTO de la colección: 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

Para CADA ELEMENTO de la colección: 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

Para CADA ELEMENTO de la colección: especifica si el objeto está visible.

visible?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

worksheet

Para CADA ELEMENTO de la colección: devuelve la hoja de cálculo a la que se limita 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

Para CADA ELEMENTO de la colección: 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 ]