workbookRange 资源类型
命名空间：microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。
表示工作簿中的一个或多个连续单元格的集合，例如单元格、行、列或单元格块。
方法
| 方法 | 返回类型 | 说明 |
|---|---|---|
| Get | workbookRange | 读取范围对象的属性和关系。 |
| 更新 | workbookRange | 更新范围对象。 |
| 删除 | None | 删除与区域关联的单元格。 |
| 清除 | None | 清除范围值、格式、填充或边框。 |
| 获取 boundingrect | workbookRange | 获取包含给定区域的最小范围对象。 例如，“B2:C5”和“D10:E15”的 GetBoundingRect 为“B2:E16”。 |
| 获取单元格 | workbookRange | 获取包含基于行号和列号的单个单元格的范围对象。 只要单元格保留在工作表网格中，单元格就可以超出其父范围的边界。 返回的单元格位于相对于区域左上角的单元格的位置。 |
| 获取列 | workbookRange | 获取区域中包含的列。 |
| 获取之后的列 | workbookRangeView | 获取给定区域右侧的一些列。 |
| 获取列之前 | workbookRangeView | 获取给定区域左侧的一些列。 |
| 获取整个列 | workbookRange | 获取一个对象，该对象代表该区域的整个列。 |
| 获取整行 | workbookRange | 获取表示区域整行的 对象。 |
| 获取交集 | workbookRange | 获取表示给定区域的矩形交集的范围对象。 |
| 获取最后一个单元格 | workbookRange | 获取区域中的最后一个单元格。 例如，“B2:D5”的最后一个单元格是“D5”。 |
| 获取最后一列 | workbookRange | 获取范围中的最后一列。 例如，“B2:D5”的最后一列是“D2:D5”。 |
| 获取最后一行 | workbookRange | 获取范围中的最后一行。 例如，“B2:D5”的最后一行是“B5:D5”。 |
| 获取偏移量范围 | workbookRange | 获取一个 对象，该对象表示从指定范围偏移的区域。 返回的范围的维度与此范围匹配。 如果强制使生成的区域位于工作表网格的边界之外，则会引发异常。 |
| 获取调整范围的大小 | workbookRangeView | 获取与当前范围对象类似的 range 对象，但其右下角展开 (或按一些行和列数收缩) 。 |
| 获取行 | workbookRange | 获取区域中包含的行。 |
| 获取上面的行 | workbookRangeView | 获取给定范围上方的一些行。 |
| 获取下面的行 | workbookRangeView | 获取给定范围以下的一些行。 |
| 获取使用的区域 | workbookRange | 返回给定范围对象的已用范围。 |
| 获取可见视图 | workbookRangeView | 获取筛选的范围中的可见范围。 |
| 插入区域 | workbookRange | 将单元格或单元格区域插入工作表中以取代此区域，并移动其他单元格以创建空间。 在现在空白的空间返回新的 Range 对象。 |
| 合并 | None | 将区域单元格合并到工作表的一个区域中。 |
| 拆分 | None | 将范围单元格取消合并为各个单元格。 |
属性
| 属性 | 类型 | 说明 |
|---|---|---|
| address | string | 表示 A1 样式的区域引用。 地址值包含工作表引用 (例如 Sheet1！A1：B4) 。 此为只读属性。 |
| addressLocal | string | 以用户语言表示对指定区域的区域引用。 只读。 |
| cellCount | int | 区域中的单元格数目。 只读。 |
| columnCount | int | 表示区域中的列总数。 只读。 |
| columnHidden | 布尔值 | 指示是否隐藏当前范围的所有列。 |
| columnIndex | int | 表示区域中第一个单元格的列编号。 从零开始编制索引。 只读。 |
| formulas | Json | 表示采用 A1 表示法的公式。 |
| formulasLocal | Json | 表示采用 A1 表示法的公式，使用用户语言和数字格式区域设置。 例如，英语中的公式 "=SUM(A1, 1.5)" 在德语中将变为 "=SUMME(A1; 1,5)"。 |
| formulasR1C1 | Json | 表示采用 R1C1 样式表示法的公式。 |
| hidden | 布尔值 | 表示当前区域中的所有单元格是否隐藏。 只读。 |
| numberFormat | Json | 表示 Excel 中指定单元格的数字格式代码。 |
| rowCount | int | 返回区域中的总行数。 只读。 |
| rowHidden | 布尔值 | 指示是否隐藏当前范围的所有行。 |
| rowIndex | int | 返回区域中第一个单元格的行编号。 从零开始编制索引。 只读。 |
| text | Json | 指定区域的文本值。 文本值不依赖于单元格宽度。 Excel UI 中发生的 # 符号替换不会影响 API 返回的文本值。 此为只读属性。 |
| valueTypes | string | 表示每个单元格的数据类型。 可能的值是：Unknown、Empty、String、Integer、Double、Boolean、Error。 只读。 |
| values | Json | 表示指定区域的原始值。 返回的数据类型可以是字符串、数字或布尔值。 包含错误的单元格返回错误字符串。 |
关系
| 关系 | 类型 | 说明 |
|---|---|---|
| format | WorkbookRangeFormat | 返回一个格式对象，其中封装了区域的字体、填充、边框、对齐方式和其他属性。 只读。 |
| sort | WorkbookRangeSort | 包含当前区域的工作表。 只读。 |
| worksheet | WorkbookWorksheet | 包含当前区域的工作表。 只读。 |
JSON 表示形式
以下 JSON 表示形式显示了资源类型。
{
"id": "string",
"address": "string",
"addressLocal": "string",
"cellCount": 1024,
"columnCount": 1024,
"columnHidden": true,
"columnIndex": 1024,
"formulas": "Json",
"formulasLocal": "Json",
"formulasR1C1": "Json",
"hidden": true,
"numberFormat": "Json",
"rowCount": 1024,
"rowHidden": true,
"rowIndex": 1024,
"text": "Json",
"valueTypes": "string",
"values": "json"
}