ExcelScript.RangeView interface

Pacote:

ExcelScript

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

Comentários

Exemplos

/**
 * This script copies values and formatting from the 
 * visible range of a table in Sheet1 into Sheet2.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the filtered data from Sheet1.
  const currentSheet = workbook.getWorksheet("Sheet1");
  const table = currentSheet.getTables()[0];
  const visibleTableRange: ExcelScript.RangeView = table.getRange().getVisibleView();
  const source = currentSheet.getRanges(visibleTableRange.getCellAddresses().toString());

  // Copy the data into the other sheet.
  const otherSheet = workbook.getWorksheet("Sheet2");
  const otherRangeCorner = otherSheet.getRange("A1");
  otherRangeCorner.copyFrom(source, ExcelScript.RangeCopyType.all);
}

Métodos

getCellAddresses()	Representa os endereços das células do RangeView.
getColumnCount()	O número de colunas visíveis.
getFormulas()	Representa a fórmula em notação A1. Se uma célula não tiver nenhuma fórmula, é devolvido o respetivo valor.
getFormulasLocal()	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 nenhuma fórmula, é devolvido o respetivo valor.
getFormulasR1C1()	Representa a fórmula em notação no estilo L1C1. Se uma célula não tiver nenhuma fórmula, é devolvido o respetivo valor.
getIndex()	Devolve um valor que representa o índice de RangeView.
getNumberFormat()	Representa o código de formato de número do Excel para determinada célula.
getRange()	Obtém o intervalo principal associado ao atual RangeView.
getRowCount()	O número de linhas visíveis.
getRows()	Representa uma coleção de exibições de tabelas associadas ao intervalo.
getText()	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.
getValues()	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.
getValueTypes()	Representa o tipo de dados de cada célula.
setFormulas(formulas)	Representa a fórmula em notação A1. Se uma célula não tiver nenhuma fórmula, é devolvido o respetivo valor.
setFormulasLocal(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 nenhuma fórmula, é devolvido o respetivo valor.
setFormulasR1C1(formulasR1C1)	Representa a fórmula em notação no estilo L1C1. Se uma célula não tiver nenhuma fórmula, é devolvido o respetivo valor.
setNumberFormat(numberFormat)	Representa o código de formato de número do Excel para determinada célula.
setValues(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.

Detalhes do método

getCellAddresses()

Representa os endereços das células do RangeView.

getCellAddresses(): string[][];

Retornos

string[][]

Exemplos

/**
 * This script copies values and formatting from the 
 * visible range of a table in Sheet1 into Sheet2.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the filtered data from Sheet1.
  const currentSheet = workbook.getWorksheet("Sheet1");
  const table = currentSheet.getTables()[0];
  const visibleTableRange: ExcelScript.RangeView = table.getRange().getVisibleView();
  const source = currentSheet.getRanges(visibleTableRange.getCellAddresses().toString());

  // Copy the data into the other sheet.
  const otherSheet = workbook.getWorksheet("Sheet2");
  const otherRangeCorner = otherSheet.getRange("A1");
  otherRangeCorner.copyFrom(source, ExcelScript.RangeCopyType.all);
}

getColumnCount()

O número de colunas visíveis.

getColumnCount(): number;

Retornos

number

getFormulas()

Representa a fórmula em notação A1. Se uma célula não tiver nenhuma fórmula, é devolvido o respetivo valor.

getFormulas(): string[][];

Retornos

string[][]

getFormulasLocal()

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 nenhuma fórmula, é devolvido o respetivo valor.

getFormulasLocal(): string[][];

Retornos

string[][]

getFormulasR1C1()

Representa a fórmula em notação no estilo L1C1. Se uma célula não tiver nenhuma fórmula, é devolvido o respetivo valor.

getFormulasR1C1(): string[][];

Retornos

string[][]

getIndex()

Devolve um valor que representa o índice de RangeView.

getIndex(): number;

Retornos

number

getNumberFormat()

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

getNumberFormat(): string[][];

Retornos

string[][]

getRange()

Obtém o intervalo principal associado ao atual RangeView.

getRange(): Range;

Retornos

ExcelScript.Range

getRowCount()

O número de linhas visíveis.

getRowCount(): number;

Retornos

number

getRows()

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

getRows(): RangeView[];

Retornos

ExcelScript.RangeView[]

getText()

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.

getText(): string[][];

Retornos

string[][]

getValues()

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.

getValues(): (string | number | boolean)[][];

Retornos

(string | number | boolean)[][]

getValueTypes()

Representa o tipo de dados de cada célula.

getValueTypes(): RangeValueType[][];

Retornos

ExcelScript.RangeValueType[][]

setFormulas(formulas)

Representa a fórmula em notação A1. Se uma célula não tiver nenhuma fórmula, é devolvido o respetivo valor.

setFormulas(formulas: string[][]): void;

Parâmetros

formulas

string[][]

Retornos

void

setFormulasLocal(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 nenhuma fórmula, é devolvido o respetivo valor.

setFormulasLocal(formulasLocal: string[][]): void;

Parâmetros

formulasLocal

string[][]

Retornos

void

setFormulasR1C1(formulasR1C1)

Representa a fórmula em notação no estilo L1C1. Se uma célula não tiver nenhuma fórmula, é devolvido o respetivo valor.

setFormulasR1C1(formulasR1C1: string[][]): void;

Parâmetros

formulasR1C1

string[][]

Retornos

void

setNumberFormat(numberFormat)

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

setNumberFormat(numberFormat: string[][]): void;

Parâmetros

numberFormat

string[][]

Retornos

void

setValues(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.

setValues(values: (string | number | boolean)[][]): void;

Parâmetros

values

(string | number | boolean)[][]

Retornos

void