Excel.NamedItemArrayValues class

Paquete:

excel

Representa un objeto que contiene valores y tipos de un elemento con nombre.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

Propiedades

context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
types	Representa los tipos de cada elemento de la matriz de elementos con nombre.
values	Representa los valores de cada elemento de la matriz de elementos con nombre.
valuesAsJson	Representación JSON de los valores de esta matriz de elementos con nombre. A diferencia de NamedItemArrayValues.values, NamedItemArrayValues.valuesAsJson 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 NamedItemArrayValues.valuesAsJsonLocal.
valuesAsJsonLocal	Representación JSON de los valores de esta matriz de elementos con nombre. A diferencia de NamedItemArrayValues.values, NamedItemArrayValues.valuesAsJsonLocal 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 NamedItemArrayValues.valuesAsJson.

Métodos

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.
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.NamedItemArrayValues original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.NamedItemArrayValuesData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

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

types

Representa los tipos de cada elemento de la matriz de elementos con nombre.

readonly types: Excel.RangeValueType[][];

Valor de propiedad

Excel.RangeValueType[][]

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

values

Representa los valores de cada elemento de la matriz de elementos con nombre.

readonly values: any[][];

Valor de propiedad

any[][]

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

valuesAsJson

Representación JSON de los valores de esta matriz de elementos con nombre. A diferencia de NamedItemArrayValues.values, NamedItemArrayValues.valuesAsJson 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 NamedItemArrayValues.valuesAsJsonLocal.

readonly valuesAsJson: CellValue[][];

Valor de propiedad

Excel.CellValue[][]

Comentarios

[ Conjunto de API: ExcelApi 1.16 ]

valuesAsJsonLocal

Representación JSON de los valores de esta matriz de elementos con nombre. A diferencia de NamedItemArrayValues.values, NamedItemArrayValues.valuesAsJsonLocal 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 NamedItemArrayValues.valuesAsJson.

readonly valuesAsJsonLocal: CellValue[][];

Valor de propiedad

Excel.CellValue[][]

Comentarios

[ Conjunto de API: ExcelApi 1.16 ]

Detalles del método

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.NamedItemArrayValuesLoadOptions): Excel.NamedItemArrayValues;

Parámetros

options

Excel.Interfaces.NamedItemArrayValuesLoadOptions

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

Devoluciones

Excel.NamedItemArrayValues

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.NamedItemArrayValues;

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

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.NamedItemArrayValues;

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

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.NamedItemArrayValues original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.NamedItemArrayValuesData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.NamedItemArrayValuesData;

Devoluciones

Excel.Interfaces.NamedItemArrayValuesData