Excel.Interfaces.RangeData interface
一个描述通过调用 range.toJSON()返回的数据的接口。
属性
| address | 指定 A1 样式的范围引用。 地址值包含工作表引用 (，例如“Sheet1！A1：B4“) 。 |
| address |
以用户的语言表示指定范围的范围引用。 |
| cell |
指定区域中的单元格数。 如果单元格数超过 2^31-1 (2,147,483,647)，此 API 返回 -1。 |
| column |
指定范围中的总列数。 |
| column |
表示是否隐藏当前区域中的所有列。 值为 |
| column |
指定区域中第一个单元格的列号。 从零开始编制索引。 |
| conditional |
与范围相交的集合 |
| control | 访问应用于此区域的单元格控件。 如果区域有多个单元格控件，则返回 |
| data |
返回数据有效性对象。 |
| format | 返回一个格式对象，其中封装了区域的字体、填充、边框、对齐方式和其他属性。 |
| formula |
指定范围的数组公式。 如果指定区域不包含数组公式，则此属性返回 |
| formulas | 表示采用 A1 表示法的公式。 如果单元格没有公式，则改为返回其值。 |
| formulas |
表示采用 A1 样式表示法的公式，使用用户的语言和数字格式区域设置。 例如，英语中的公式 "=SUM(A1, 1.5)" 在德语中将变为 "=SUMME(A1; 1,5)"。 如果单元格没有公式，则改为返回其值。 |
| formulasR1C1 | 表示采用 R1C1 样式表示法的公式。 如果单元格没有公式，则改为返回其值。 |
| has |
表示所有单元格是否都具有溢出边框。 如果所有单元格都有溢出边框，或者 |
| height | 返回从范围的顶部边缘到范围底部边缘的距离（以点为单位进行 100% 缩放）。 |
| hidden | 表示当前区域内的所有单元格是否全部隐藏。 值为 |
| hyperlink | 表示当前范围的超链接。 |
| is |
表示当前区域是否为整列。 |
| is |
表示当前区域是否为整行。 |
| left | 返回对于 100% 缩放的从工作表左边缘到区域左边缘的距离（以点为单位）。 |
| linked |
表示每个单元格的数据类型状态。 |
| number |
表示给定范围的 Excel 的数字格式代码。 有关 Excel 数字格式的详细信息，请参阅数字格式代码。 |
| number |
表示每个单元格的数字格式类别。 |
| number |
表示基于用户语言设置的给定范围的 Excel 数字格式代码。 Excel 在获取或设置属性时不 |
| row |
返回区域中的总行数。 |
| row |
表示是否隐藏当前区域中的所有行。 值为 |
| row |
返回区域中第一个单元格的行编号。 从零开始编制索引。 |
| saved |
表示是否将所有单元格都另存为数组公式。
|
| style | 表示当前区域的样式。 如果单元格的样式不一致， |
| text | 指定区域的文本值。 文本值与单元格宽度无关。 Excel UI 中发生的数字符号 (#) 替换不会影响 API 返回的文本值。 |
| top | 返回从工作表的上边缘到区域的上边缘的距离（以点为单位进行 100% 缩放）。 |
| values | 表示指定区域的原始值。 返回的数据可以是字符串、数字或布尔值。 包含错误的单元格将返回错误字符串。 如果返回的值以加号 (“+”) 开头、减号 (“-”) 或等号 (“=”) ，Excel 会将此值解释为公式。 |
| values |
此区域中单元格值的 JSON 表示形式。 与 不同， |
| values |
此区域中单元格值的 JSON 表示形式。 与 不同， |
| value |
指定每个单元格中的数据类型。 |
| width | 返回对于 100% 缩放，从范围左边缘到范围右边缘的距离（以点为单位）。 |
属性详细信息
address
addressLocal
cellCount
指定区域中的单元格数。 如果单元格数超过 2^31-1 (2,147,483,647)，此 API 返回 -1。
cellCount?: number;属性值
number
注解
columnCount
columnHidden
表示是否隐藏当前区域中的所有列。 值为 true 隐藏某个区域中的所有列的情况。 值为 false 隐藏范围内任何列的情况。 值是指 null 隐藏某个区域中的某些列，而同一区域中的其他列未隐藏。
columnHidden?: boolean;属性值
boolean
注解
columnIndex
conditionalFormats
与范围相交的集合 ConditionalFormats 。
conditionalFormats?: Excel.Interfaces.ConditionalFormatData[];属性值
注解
control
访问应用于此区域的单元格控件。 如果区域有多个单元格控件，则返回 EmptyCellControl。
control?: CellControl;属性值
注解
dataValidation
返回数据有效性对象。
dataValidation?: Excel.Interfaces.DataValidationData;属性值
注解
format
返回一个格式对象，其中封装了区域的字体、填充、边框、对齐方式和其他属性。
format?: Excel.Interfaces.RangeFormatData;属性值
注解
formulaArray
指定范围的数组公式。 如果指定区域不包含数组公式，则此属性返回 null。
formulaArray?: string;属性值
string
注解
formulas
formulasLocal
表示采用 A1 样式表示法的公式，使用用户的语言和数字格式区域设置。 例如，英语中的公式 "=SUM(A1, 1.5)" 在德语中将变为 "=SUMME(A1; 1,5)"。 如果单元格没有公式，则改为返回其值。
formulasLocal?: any[][];属性值
any[][]
注解
formulasR1C1
hasSpill
表示所有单元格是否都具有溢出边框。 如果所有单元格都有溢出边框，或者false所有单元格都没有溢出边框，则返回true。 如果范围内存在带有溢出边框和不带溢出边框的单元格，则返回 null 。
hasSpill?: boolean;属性值
boolean
注解
height
hidden
表示当前区域内的所有单元格是否全部隐藏。 值为 true 隐藏区域中的所有单元格时。 值为 false 区域内没有隐藏任何单元格时。 值表示 null 某个区域中的某些单元格处于隐藏状态，而同一区域中的其他单元格未隐藏。
hidden?: boolean;属性值
boolean
注解
hyperlink
isEntireColumn
isEntireRow
left
linkedDataTypeState
表示每个单元格的数据类型状态。
linkedDataTypeState?: Excel.LinkedDataTypeState[][];属性值
注解
numberFormat
numberFormatCategories
表示每个单元格的数字格式类别。
numberFormatCategories?: Excel.NumberFormatCategory[][];属性值
注解
numberFormatLocal
表示基于用户语言设置的给定范围的 Excel 数字格式代码。 Excel 在获取或设置属性时不 numberFormatLocal 执行任何语言或格式强制。 任何返回的文本都将根据系统设置中指定的语言使用本地格式化的字符串。
numberFormatLocal?: any[][];属性值
any[][]
注解
rowCount
rowHidden
表示是否隐藏当前区域中的所有行。 值为 true 隐藏区域中的所有行的情况。 值为 false 范围内没有隐藏行的情况。 值表示 null 隐藏某个区域中的某些行，而同一区域中的其他行不隐藏。
rowHidden?: boolean;属性值
boolean
注解
rowIndex
savedAsArray
表示是否将所有单元格都另存为数组公式。
true返回所有单元格是否将另存为数组公式，或者false所有单元格不会另存为数组公式。
null返回某些单元格将另存为数组公式，而某些单元格将不保存为数组公式。
savedAsArray?: boolean;属性值
boolean
注解
style
表示当前区域的样式。 如果单元格的样式不一致， null 将返回。 对于自定义样式，将返回样式名称。 对于内置样式，将返回表示枚举中 BuiltInStyle 值的字符串。
style?: string;属性值
string
注解
text
指定区域的文本值。 文本值与单元格宽度无关。 Excel UI 中发生的数字符号 (#) 替换不会影响 API 返回的文本值。
text?: string[][];属性值
string[][]
注解
top
values
表示指定区域的原始值。 返回的数据可以是字符串、数字或布尔值。 包含错误的单元格将返回错误字符串。 如果返回的值以加号 (“+”) 开头、减号 (“-”) 或等号 (“=”) ，Excel 会将此值解释为公式。
values?: any[][];属性值
any[][]
注解
valuesAsJson
此区域中单元格值的 JSON 表示形式。 与 不同， Range.values支持 Range.valuesAsJson 可以在单元格中的所有数据类型。 示例包括格式化数字值和 Web 图像，以及标准布尔值、数字和字符串值。 从此 API 返回的数据始终与 en-US 区域设置一致。 要检索用户显示区域设置中的数据，请使用 Range.valuesAsJsonLocal。
valuesAsJson?: CellValue[][];属性值
Excel.CellValue[][]
注解
valuesAsJsonLocal
此区域中单元格值的 JSON 表示形式。 与 不同， Range.values支持 Range.valuesAsJsonLocal 可以在单元格中的所有数据类型。 示例包括格式化数字值和 Web 图像，以及标准布尔值、数字和字符串值。 从此 API 返回的数据始终与用户的显示区域设置一致。 要检索独立于区域设置的数据，请使用 Range.valuesAsJson。
valuesAsJsonLocal?: CellValue[][];属性值
Excel.CellValue[][]
注解
valueTypes
指定每个单元格中的数据类型。
valueTypes?: Excel.RangeValueType[][];