Excel.RangeView class

  • 参考
包:
excel

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

Extends
OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.3 ]

属性

cellAddresses

表示 的 RangeView单元格地址。
columnCount

可见列的数目。
context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
formulas

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

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

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

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

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

可见行数。
rows

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

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

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

此区域中单元格中值的 JSON 表示形式。 与 不同 RangeView.values， RangeView.valuesAsJson 支持可在单元格中的所有数据类型。 示例包括格式化的数字值和 Web 图像，以及标准布尔值、数字值和字符串值。 从此 API 返回的数据始终与 en-US 区域设置一致。 若要检索用户的显示区域设置中的数据，请使用 RangeView.valuesAsJsonLocal。
valuesAsJsonLocal

此区域中单元格中值的 JSON 表示形式。 与 不同 RangeView.values， RangeView.valuesAsJsonLocal 支持可在单元格中的所有数据类型。 示例包括格式化的数字值和 Web 图像，以及标准布尔值、数字值和字符串值。 从此 API 返回的数据始终与用户的显示区域设置保持一致。 若要检索独立于区域设置的数据，请使用 RangeView.valuesAsJson。
valueTypes

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

方法

getRange()

获取与当前 RangeView关联的父区域。
load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties)

基于现有的已加载对象，同时对对象设置多个属性。
toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始 Excel.RangeView 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.RangeViewData) ，其中包含原始对象中任何已加载子属性的浅表副本。

属性详细信息

cellAddresses

表示 的 RangeView单元格地址。

readonly cellAddresses: any[][];

属性值

any[][]

注解

[ API 集：ExcelApi 1.3 ]

columnCount

可见列的数目。

readonly columnCount: number;

属性值

number

注解

[ API 集：ExcelApi 1.3 ]

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

Excel.RequestContext

formulas

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

formulas: any[][];

属性值

any[][]

注解

[ API 集：ExcelApi 1.3 ]

formulasLocal

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

formulasLocal: any[][];

属性值

any[][]

注解

[ API 集：ExcelApi 1.3 ]

formulasR1C1

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

formulasR1C1: any[][];

属性值

any[][]

注解

[ API 集：ExcelApi 1.3 ]

index

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

readonly index: number;

属性值

number

注解

[ API 集：ExcelApi 1.3 ]

numberFormat

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

numberFormat: any[][];

属性值

any[][]

注解

[ API 集：ExcelApi 1.3 ]

rowCount

可见行数。

readonly rowCount: number;

属性值

number

注解

[ API 集：ExcelApi 1.3 ]

rows

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

readonly rows: Excel.RangeViewCollection;

属性值

Excel.RangeViewCollection

注解

[ API 集：ExcelApi 1.3 ]

text

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

readonly text: string[][];

属性值

string[][]

注解

[ API 集：ExcelApi 1.3 ]

values

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

values: any[][];

属性值

any[][]

注解

[ API 集：ExcelApi 1.3 ]

valuesAsJson

此区域中单元格中值的 JSON 表示形式。 与 不同 RangeView.values， RangeView.valuesAsJson 支持可在单元格中的所有数据类型。 示例包括格式化的数字值和 Web 图像，以及标准布尔值、数字值和字符串值。 从此 API 返回的数据始终与 en-US 区域设置一致。 若要检索用户的显示区域设置中的数据，请使用 RangeView.valuesAsJsonLocal。

valuesAsJson: CellValue[][];

属性值

Excel.CellValue[][]

注解

[ API 集：ExcelApi 1.16 ]

valuesAsJsonLocal

此区域中单元格中值的 JSON 表示形式。 与 不同 RangeView.values， RangeView.valuesAsJsonLocal 支持可在单元格中的所有数据类型。 示例包括格式化的数字值和 Web 图像，以及标准布尔值、数字值和字符串值。 从此 API 返回的数据始终与用户的显示区域设置保持一致。 若要检索独立于区域设置的数据，请使用 RangeView.valuesAsJson。

valuesAsJsonLocal: CellValue[][];

属性值

Excel.CellValue[][]

注解

[ API 集：ExcelApi 1.16 ]

valueTypes

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

readonly valueTypes: Excel.RangeValueType[][];

属性值

Excel.RangeValueType[][]

注解

[ API 集：ExcelApi 1.3 ]

方法详细信息

getRange()

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

getRange(): Excel.Range;

返回

Excel.Range

注解

[ API 集：ExcelApi 1.3 ]

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: Excel.Interfaces.RangeViewLoadOptions): Excel.RangeView;

参数

options
Excel.Interfaces.RangeViewLoadOptions

提供要加载对象的属性的选项。

返回

Excel.RangeView

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNames?: string | string[]): Excel.RangeView;

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

Excel.RangeView

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.RangeView;

参数

propertyNamesAndPaths

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

propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。

返回

Excel.RangeView

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。

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

参数

properties
Excel.Interfaces.RangeViewUpdateData

一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。

options
OfficeExtension.UpdateOptions

提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

返回

void

set(properties)

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: Excel.RangeView): void;

参数

properties
Excel.RangeView

返回

void

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始 Excel.RangeView 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.RangeViewData) ，其中包含原始对象中任何已加载子属性的浅表副本。

toJSON(): Excel.Interfaces.RangeViewData;

返回

Excel.Interfaces.RangeViewData