ExcelScript.RangeView interface

包:

ExcelScript

RangeView 表示父范围的一组可见单元格。

注解

示例

/**
 * 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);
}

方法

getCellAddresses()	表示 的 RangeView单元格地址。
getColumnCount()	可见列的数目。
getFormulas()	表示采用 A1 表示法的公式。 如果单元格没有公式，则返回其值。
getFormulasLocal()	表示采用 A1 样式表示法的公式，使用用户的语言和数字格式区域设置。 例如，英语中的公式 "=SUM(A1, 1.5)" 在德语中将变为 "=SUMME(A1; 1,5)"。 如果单元格没有公式，则返回其值。
getFormulasR1C1()	表示采用 R1C1 样式表示法的公式。 如果单元格没有公式，则返回其值。
getIndex()	返回一个值，该值表示 的 RangeView索引。
getNumberFormat()	表示 Excel 中指定单元格的数字格式代码。
getRange()	获取与当前 RangeView关联的父区域。
getRowCount()	可见行数。
getRows()	表示一组与 range 相关联的 RangeView。
getText()	指定区域的文本值。 文本值与单元格宽度无关。 在 Excel UI 中替代 # 符号不会影响 API 返回的文本值。
getValues()	表示指定的 RangeView 的原始值。 返回的数据可能是字符串、数字，也可能是布尔值。 包含错误的单元格将返回错误字符串。
getValueTypes()	表示每个单元格的数据类型。
setFormulas(formulas)	表示采用 A1 表示法的公式。 如果单元格没有公式，则返回其值。
setFormulasLocal(formulasLocal)	表示采用 A1 样式表示法的公式，使用用户的语言和数字格式区域设置。 例如，英语中的公式 "=SUM(A1, 1.5)" 在德语中将变为 "=SUMME(A1; 1,5)"。 如果单元格没有公式，则返回其值。
setFormulasR1C1(formulasR1C1)	表示采用 R1C1 样式表示法的公式。 如果单元格没有公式，则返回其值。
setNumberFormat(numberFormat)	表示 Excel 中指定单元格的数字格式代码。
setValues(values)	表示指定的 RangeView 的原始值。 返回的数据可能是字符串、数字，也可能是布尔值。 包含错误的单元格将返回错误字符串。

方法详细信息

getCellAddresses()

表示 的 RangeView单元格地址。

getCellAddresses(): string[][];

返回

string[][]

示例

/**
 * 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()

可见列的数目。

getColumnCount(): number;

返回

number

getFormulas()

表示采用 A1 表示法的公式。 如果单元格没有公式，则返回其值。

getFormulas(): string[][];

返回

string[][]

getFormulasLocal()

表示采用 A1 样式表示法的公式，使用用户的语言和数字格式区域设置。 例如，英语中的公式 "=SUM(A1, 1.5)" 在德语中将变为 "=SUMME(A1; 1,5)"。 如果单元格没有公式，则返回其值。

getFormulasLocal(): string[][];

返回

string[][]

getFormulasR1C1()

表示采用 R1C1 样式表示法的公式。 如果单元格没有公式，则返回其值。

getFormulasR1C1(): string[][];

返回

string[][]

getIndex()

返回一个值，该值表示 的 RangeView索引。

getIndex(): number;

返回

number

getNumberFormat()

表示 Excel 中指定单元格的数字格式代码。

getNumberFormat(): string[][];

返回

string[][]

getRange()

获取与当前 RangeView关联的父区域。

getRange(): Range;

返回

ExcelScript.Range

getRowCount()

可见行数。

getRowCount(): number;

返回

number

getRows()

表示一组与 range 相关联的 RangeView。

getRows(): RangeView[];

返回

ExcelScript.RangeView[]

getText()

指定区域的文本值。 文本值与单元格宽度无关。 在 Excel UI 中替代 # 符号不会影响 API 返回的文本值。

getText(): string[][];

返回

string[][]

getValues()

表示指定的 RangeView 的原始值。 返回的数据可能是字符串、数字，也可能是布尔值。 包含错误的单元格将返回错误字符串。

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

返回

(string | number | boolean)[][]

getValueTypes()

表示每个单元格的数据类型。

getValueTypes(): RangeValueType[][];

返回

ExcelScript.RangeValueType[][]

setFormulas(formulas)

表示采用 A1 表示法的公式。 如果单元格没有公式，则返回其值。

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

参数

formulas

string[][]

返回

void

setFormulasLocal(formulasLocal)

表示采用 A1 样式表示法的公式，使用用户的语言和数字格式区域设置。 例如，英语中的公式 "=SUM(A1, 1.5)" 在德语中将变为 "=SUMME(A1; 1,5)"。 如果单元格没有公式，则返回其值。

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

参数

formulasLocal

string[][]

返回

void

setFormulasR1C1(formulasR1C1)

表示采用 R1C1 样式表示法的公式。 如果单元格没有公式，则返回其值。

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

参数

formulasR1C1

string[][]

返回

void

setNumberFormat(numberFormat)

表示 Excel 中指定单元格的数字格式代码。

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

参数

numberFormat

string[][]

返回

void

setValues(values)

表示指定的 RangeView 的原始值。 返回的数据可能是字符串、数字，也可能是布尔值。 包含错误的单元格将返回错误字符串。

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

参数

values

(string | number | boolean)[][]

返回

void