Excel.RangeView class

Pacote:

excel

RangeView representa um conjunto de células visíveis do intervalo pai.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

Propriedades

cellAddresses	Representa os endereços de célula do RangeView.
columnCount	O número de colunas visíveis.
context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
formulas	Representa a fórmula em notação A1. Se uma célula não tiver fórmula, seu valor será retornado.
formulasLocal	Representa a fórmula em notação A1, na formatação de número da localidade e no idioma do usuário. Por exemplo, a fórmula "=SUM(A1, 1.5)" em inglês seria "=SOMA(A1; 1,5)" em português. Se uma célula não tiver fórmula, seu valor será retornado.
formulasR1C1	Representa a fórmula em notação no estilo L1C1. Se uma célula não tiver fórmula, seu valor será retornado.
index	Retorna um valor que representa o índice do RangeView.
numberFormat	Representa o código de formato de número do Excel para determinada célula.
rowCount	O número de linhas visíveis.
rows	Representa uma coleção de exibições de tabelas associadas ao intervalo.
text	Valores de texto do intervalo especificado. O valor de texto não depende da largura da célula. A substituição do sinal # que ocorre na interface do usuário do Excel não afeta o valor de texto retornado pela API.
values	Representa os valores brutos da exibição do intervalo especificado. Os dados retornados podem ser dos tipos: cadeia de caracteres, número ou booliano. Células que contêm um erro retornarão a cadeia de caracteres de erro.
valuesAsJson	Uma representação JSON dos valores nas células nesse intervalo. Ao contrário RangeView.valuesde , RangeView.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 RangeView.valuesAsJsonLocal.
valuesAsJsonLocal	Uma representação JSON dos valores nas células nesse intervalo. Ao contrário RangeView.valuesde , RangeView.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 RangeView.valuesAsJson.
valueTypes	Representa o tipo de dados de cada célula.

Métodos

getRange()	Obtém o intervalo pai associado ao atual RangeView.
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.
set(properties, options)	Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
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.RangeView original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.RangeViewData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Detalhes da propriedade

cellAddresses

Representa os endereços de célula do RangeView.

readonly cellAddresses: any[][];

Valor da propriedade

any[][]

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

columnCount

O número de colunas visíveis.

readonly columnCount: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

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

formulas

Representa a fórmula em notação A1. Se uma célula não tiver fórmula, seu valor será retornado.

formulas: any[][];

Valor da propriedade

any[][]

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

formulasLocal

Representa a fórmula em notação A1, na formatação de número da localidade e no idioma do usuário. Por exemplo, a fórmula "=SUM(A1, 1.5)" em inglês seria "=SOMA(A1; 1,5)" em português. Se uma célula não tiver fórmula, seu valor será retornado.

formulasLocal: any[][];

Valor da propriedade

any[][]

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

formulasR1C1

Representa a fórmula em notação no estilo L1C1. Se uma célula não tiver fórmula, seu valor será retornado.

formulasR1C1: any[][];

Valor da propriedade

any[][]

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

index

Retorna um valor que representa o índice do RangeView.

readonly index: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

numberFormat

Representa o código de formato de número do Excel para determinada célula.

numberFormat: any[][];

Valor da propriedade

any[][]

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

rowCount

O número de linhas visíveis.

readonly rowCount: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

rows

Representa uma coleção de exibições de tabelas associadas ao intervalo.

readonly rows: Excel.RangeViewCollection;

Valor da propriedade

Excel.RangeViewCollection

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

text

Valores de texto do intervalo especificado. O valor de texto não depende da largura da célula. A substituição do sinal # que ocorre na interface do usuário do Excel não afeta o valor de texto retornado pela API.

readonly text: string[][];

Valor da propriedade

string[][]

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

values

Representa os valores brutos da exibição do intervalo especificado. Os dados retornados podem ser dos tipos: cadeia de caracteres, número ou booliano. Células que contêm um erro retornarão a cadeia de caracteres de erro.

values: any[][];

Valor da propriedade

any[][]

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

valuesAsJson

Uma representação JSON dos valores nas células nesse intervalo. Ao contrário RangeView.valuesde , RangeView.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 RangeView.valuesAsJsonLocal.

valuesAsJson: CellValue[][];

Valor da propriedade

Excel.CellValue[][]

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

valuesAsJsonLocal

Uma representação JSON dos valores nas células nesse intervalo. Ao contrário RangeView.valuesde , RangeView.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 RangeView.valuesAsJson.

valuesAsJsonLocal: CellValue[][];

Valor da propriedade

Excel.CellValue[][]

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

valueTypes

Representa o tipo de dados de cada célula.

readonly valueTypes: Excel.RangeValueType[][];

Valor da propriedade

Excel.RangeValueType[][]

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

Detalhes do método

getRange()

Obtém o intervalo pai associado ao atual RangeView.

getRange(): Excel.Range;

Retornos

Excel.Range

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

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.RangeViewLoadOptions): Excel.RangeView;

Parâmetros

options

Excel.Interfaces.RangeViewLoadOptions

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

Retornos

Excel.RangeView

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

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

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

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

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

properties

Excel.Interfaces.RangeViewUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options

OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Excel.RangeView): void;

Parâmetros

properties

Excel.RangeView

Retornos

void

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.RangeView original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.RangeViewData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.RangeViewData;

Retornos

Excel.Interfaces.RangeViewData