Excel.NamedItemArrayValues class

Pacote:

excel

Representa um objeto que contém valores e tipos de um item nomeado.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Propriedades

context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
types	Representa os tipos para cada item na matriz de itens nomeada
values	Representa os valores de cada item na matriz de itens nomeados.
valuesAsJson	Uma representação JSON dos valores nesta matriz de itens nomeada. Ao contrário NamedItemArrayValues.valuesde , NamedItemArrayValues.valuesAsJson dá suporte a todos os tipos de dados que podem estar em uma célula. Exemplos incluem valores de número formatado e imagens da Web, além dos valores padrão booliano, número e cadeia de caracteres. Os dados retornados dessa API sempre se alinham com a localidade en-US. Para recuperar dados na localidade de exibição do usuário, use NamedItemArrayValues.valuesAsJsonLocal.
valuesAsJsonLocal	Uma representação JSON dos valores nesta matriz de itens nomeada. Ao contrário NamedItemArrayValues.valuesde , NamedItemArrayValues.valuesAsJsonLocal dá suporte a todos os tipos de dados que podem estar em uma célula. Exemplos incluem valores de número formatado e imagens da Web, além dos valores padrão booliano, número e cadeia de caracteres. Os dados retornados dessa API sempre se alinham à localidade de exibição do usuário. Para recuperar dados independentes da localidade, use NamedItemArrayValues.valuesAsJson.

Métodos

load(options)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
toJSON()	Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.NamedItemArrayValues original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.NamedItemArrayValuesData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Detalhes da propriedade

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

types

Representa os tipos para cada item na matriz de itens nomeada

readonly types: Excel.RangeValueType[][];

Valor da propriedade

Excel.RangeValueType[][]

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

values

Representa os valores de cada item na matriz de itens nomeados.

readonly values: any[][];

Valor da propriedade

any[][]

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

valuesAsJson

Uma representação JSON dos valores nesta matriz de itens nomeada. Ao contrário NamedItemArrayValues.valuesde , NamedItemArrayValues.valuesAsJson dá suporte a todos os tipos de dados que podem estar em uma célula. Exemplos incluem valores de número formatado e imagens da Web, além dos valores padrão booliano, número e cadeia de caracteres. Os dados retornados dessa API sempre se alinham com a localidade en-US. Para recuperar dados na localidade de exibição do usuário, use NamedItemArrayValues.valuesAsJsonLocal.

readonly valuesAsJson: CellValue[][];

Valor da propriedade

Excel.CellValue[][]

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

valuesAsJsonLocal

Uma representação JSON dos valores nesta matriz de itens nomeada. Ao contrário NamedItemArrayValues.valuesde , NamedItemArrayValues.valuesAsJsonLocal dá suporte a todos os tipos de dados que podem estar em uma célula. Exemplos incluem valores de número formatado e imagens da Web, além dos valores padrão booliano, número e cadeia de caracteres. Os dados retornados dessa API sempre se alinham à localidade de exibição do usuário. Para recuperar dados independentes da localidade, use NamedItemArrayValues.valuesAsJson.

readonly valuesAsJsonLocal: CellValue[][];

Valor da propriedade

Excel.CellValue[][]

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

Detalhes do método

load(options)

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

Parâmetros

options

Excel.Interfaces.NamedItemArrayValuesLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Excel.NamedItemArrayValues

load(propertyNames)

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

Parâmetros

propertyNames

string | string[]

Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

Excel.NamedItemArrayValues

load(propertyNamesAndPaths)

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

Parâmetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Excel.NamedItemArrayValues

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.NamedItemArrayValues original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.NamedItemArrayValuesData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.NamedItemArrayValuesData;

Retornos

Excel.Interfaces.NamedItemArrayValuesData