Excel.Interfaces.RangeCollectionLoadOptions interface

属性

$all

指定加载选项将 $all 加载所有标量属性 ((如 Range.address) ),但不会加载导航属性 ((如 Range.format.fill.color) )。

address

对于集合中的每个项目: 指定 A1 样式的范围引用。 地址值包含工作表引用 (,例如“Sheet1!A1:B4“) 。

addressLocal

对于集合中的每个项目: 以用户的语言表示指定范围的范围引用。

cellCount

对于集合中的每个项: 指定区域中的单元格数。 如果单元格数超过 2^31-1 (2,147,483,647),此 API 返回 -1。

columnCount

For EACH ITEM in the collection: 指定区域内的总列数。

columnHidden

For EACH ITEM in the collection: 表示当前区域中的所有列是否都已隐藏。 值为 true 隐藏某个区域中的所有列的情况。 值为 false 隐藏范围内任何列的情况。 值是指 null 隐藏某个区域中的某些列,而同一区域中的其他列未隐藏。

columnIndex

对于集合中的每个项目: 指定区域中第一个单元格的列号。 从零开始编制索引。

control

For EACH ITEM in the collection: 访问应用于此区域的单元格控件。 如果区域有多个单元格控件,则返回 EmptyCellControl

dataValidation

对于集合中的每个项目: 返回数据验证对象。

format

For EACH ITEM in the collection: 返回格式对象,封装区域的字体、填充、边框、对齐方式和其他属性。

formulaArray

对于集合中的每个项目: 指定范围的数组公式。 如果指定区域不包含数组公式,则此属性返回 null

formulas

For EACH ITEM in the collection: 表示公式的 A1 样式表示法。 如果单元格没有公式,则改为返回其值。

formulasLocal

对于集合中的每个项目:以 A1 样式表示法、用户语言和数字格式区域设置的公式。 例如,英语中的公式 "=SUM(A1, 1.5)" 在德语中将变为 "=SUMME(A1; 1,5)"。 如果单元格没有公式,则改为返回其值。

formulasR1C1

For EACH ITEM in the collection: 表示公式的 R1C1 样式表示法。 如果单元格没有公式,则改为返回其值。

hasSpill

对于集合中的每个项:表示是否所有单元格都具有溢出边框。 如果所有单元格都有溢出边框,或者false所有单元格都没有溢出边框,则返回true。 如果范围内存在带有溢出边框和不带溢出边框的单元格,则返回 null

height

对于集合中的每个项目:返回从范围的顶部边缘到范围底部边缘的距离(以点为单位进行 100% 缩放)。

hidden

对于集合中的每个项:表示当前区域中的所有单元格是否都隐藏。 值为 true 隐藏区域中的所有单元格时。 值为 false 区域内没有隐藏任何单元格时。 值表示 null 某个区域中的某些单元格处于隐藏状态,而同一区域中的其他单元格未隐藏。

hyperlink

对于集合中的每个项目: 表示当前范围的超链接。

isEntireColumn

For EACH ITEM in the collection: 表示当前区域是否为整列。

isEntireRow

For EACH ITEM in the collection:表示当前范围是否为整行。

left

对于集合中的每个项目:返回从工作表左边缘到区域左边缘的距离(以 100% 缩放为单位)。

linkedDataTypeState

For EACH ITEM in the collection: 表示每个单元格的数据类型状态。

numberFormat

For EACH ITEM in the collection: 表示给定区域的 Excel 的数字格式代码。 有关 Excel 数字格式的详细信息,请参阅数字格式代码

numberFormatCategories

For EACH ITEM in the collection: 表示每个单元格的数字格式类别。

numberFormatLocal

对于集合中的每个项:根据用户的语言设置,表示给定范围的 Excel 数字格式代码。 Excel 在获取或设置属性时不 numberFormatLocal 执行任何语言或格式强制。 任何返回的文本都将根据系统设置中指定的语言使用本地格式化的字符串。

rowCount

For EACH ITEM in the collection: 返回区域中的总行数。

rowHidden

For EACH ITEM in the collection:表示当前区域内的所有行是否全部隐藏。 值为 true 隐藏区域中的所有行的情况。 值为 false 范围内没有隐藏行的情况。 值表示 null 隐藏某个区域中的某些行,而同一区域中的其他行不隐藏。

rowIndex

For EACH ITEM in the collection:返回区域中第一个单元格的行号。 从零开始编制索引。

savedAsArray

对于集合中的每个项:表示是否所有单元格都将另存为数组公式。 true返回所有单元格是否将另存为数组公式,或者false所有单元格不会另存为数组公式。 null返回某些单元格将另存为数组公式,而某些单元格将不保存为数组公式。

style

对于集合中的每个项目: 表示当前范围的样式。 如果单元格的样式不一致, null 将返回。 对于自定义样式,将返回样式名称。 对于内置样式,将返回表示枚举中 BuiltInStyle 值的字符串。

text

对于集合中的每个项目: 指定区域的文本值。 文本值与单元格宽度无关。 Excel UI 中发生的数字符号 (#) 替换不会影响 API 返回的文本值。

top

对于集合中的每个项:返回对于 100% 缩放的从工作表顶部边缘到范围顶部边缘的距离(以磅为单位)。

values

For EACH ITEM in the collection: 表示指定区域的原始值。 返回的数据可以是字符串、数字或布尔值。 包含错误的单元格将返回错误字符串。 如果返回的值以加号 (“+”) 开头、减号 (“-”) 或等号 (“=”) ,Excel 会将此值解释为公式。

valuesAsJson

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

valuesAsJsonLocal

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

valueTypes

对于集合中的每个项: 指定每个单元格中的数据类型。

width

对于集合中的每个项目:返回从范围左边缘到范围右边缘的距离(以 100% 缩放为单位)。

worksheet

对于集合中的每个项:包含当前范围的工作表。

属性详细信息

$all

指定加载选项将 $all 加载所有标量属性 ((如 Range.address) ),但不会加载导航属性 ((如 Range.format.fill.color) )。

$all?: boolean;

属性值

boolean

address

对于集合中的每个项目: 指定 A1 样式的范围引用。 地址值包含工作表引用 (,例如“Sheet1!A1:B4“) 。

address?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.1

addressLocal

对于集合中的每个项目: 以用户的语言表示指定范围的范围引用。

addressLocal?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.1

cellCount

对于集合中的每个项: 指定区域中的单元格数。 如果单元格数超过 2^31-1 (2,147,483,647),此 API 返回 -1。

cellCount?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.1

columnCount

For EACH ITEM in the collection: 指定区域内的总列数。

columnCount?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.1

columnHidden

For EACH ITEM in the collection: 表示当前区域中的所有列是否都已隐藏。 值为 true 隐藏某个区域中的所有列的情况。 值为 false 隐藏范围内任何列的情况。 值是指 null 隐藏某个区域中的某些列,而同一区域中的其他列未隐藏。

columnHidden?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.2

columnIndex

对于集合中的每个项目: 指定区域中第一个单元格的列号。 从零开始编制索引。

columnIndex?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.1

control

For EACH ITEM in the collection: 访问应用于此区域的单元格控件。 如果区域有多个单元格控件,则返回 EmptyCellControl

control?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.18

dataValidation

对于集合中的每个项目: 返回数据验证对象。

dataValidation?: Excel.Interfaces.DataValidationLoadOptions;

属性值

注解

API 集:ExcelApi 1.9

format

For EACH ITEM in the collection: 返回格式对象,封装区域的字体、填充、边框、对齐方式和其他属性。

format?: Excel.Interfaces.RangeFormatLoadOptions;

属性值

注解

API 集:ExcelApi 1.9

formulaArray

对于集合中的每个项目: 指定范围的数组公式。 如果指定区域不包含数组公式,则此属性返回 null

formulaArray?: boolean;

属性值

boolean

注解

API 集:ExcelApiDesktop 1.1

formulas

For EACH ITEM in the collection: 表示公式的 A1 样式表示法。 如果单元格没有公式,则改为返回其值。

formulas?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.1

formulasLocal

对于集合中的每个项目:以 A1 样式表示法、用户语言和数字格式区域设置的公式。 例如,英语中的公式 "=SUM(A1, 1.5)" 在德语中将变为 "=SUMME(A1; 1,5)"。 如果单元格没有公式,则改为返回其值。

formulasLocal?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.1

formulasR1C1

For EACH ITEM in the collection: 表示公式的 R1C1 样式表示法。 如果单元格没有公式,则改为返回其值。

formulasR1C1?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.2

hasSpill

对于集合中的每个项:表示是否所有单元格都具有溢出边框。 如果所有单元格都有溢出边框,或者false所有单元格都没有溢出边框,则返回true。 如果范围内存在带有溢出边框和不带溢出边框的单元格,则返回 null

hasSpill?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.12

height

对于集合中的每个项目:返回从范围的顶部边缘到范围底部边缘的距离(以点为单位进行 100% 缩放)。

height?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.10

hidden

对于集合中的每个项:表示当前区域中的所有单元格是否都隐藏。 值为 true 隐藏区域中的所有单元格时。 值为 false 区域内没有隐藏任何单元格时。 值表示 null 某个区域中的某些单元格处于隐藏状态,而同一区域中的其他单元格未隐藏。

hidden?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.2

对于集合中的每个项目: 表示当前范围的超链接。

hyperlink?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.7

isEntireColumn

For EACH ITEM in the collection: 表示当前区域是否为整列。

isEntireColumn?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.7

isEntireRow

For EACH ITEM in the collection:表示当前范围是否为整行。

isEntireRow?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.7

left

对于集合中的每个项目:返回从工作表左边缘到区域左边缘的距离(以 100% 缩放为单位)。

left?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.10

linkedDataTypeState

For EACH ITEM in the collection: 表示每个单元格的数据类型状态。

linkedDataTypeState?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.9

numberFormat

For EACH ITEM in the collection: 表示给定区域的 Excel 的数字格式代码。 有关 Excel 数字格式的详细信息,请参阅数字格式代码

numberFormat?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.1

numberFormatCategories

For EACH ITEM in the collection: 表示每个单元格的数字格式类别。

numberFormatCategories?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.12

numberFormatLocal

对于集合中的每个项:根据用户的语言设置,表示给定范围的 Excel 数字格式代码。 Excel 在获取或设置属性时不 numberFormatLocal 执行任何语言或格式强制。 任何返回的文本都将根据系统设置中指定的语言使用本地格式化的字符串。

numberFormatLocal?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.7

rowCount

For EACH ITEM in the collection: 返回区域中的总行数。

rowCount?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.1

rowHidden

For EACH ITEM in the collection:表示当前区域内的所有行是否全部隐藏。 值为 true 隐藏区域中的所有行的情况。 值为 false 范围内没有隐藏行的情况。 值表示 null 隐藏某个区域中的某些行,而同一区域中的其他行不隐藏。

rowHidden?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.2

rowIndex

For EACH ITEM in the collection:返回区域中第一个单元格的行号。 从零开始编制索引。

rowIndex?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.1

savedAsArray

对于集合中的每个项:表示是否所有单元格都将另存为数组公式。 true返回所有单元格是否将另存为数组公式,或者false所有单元格不会另存为数组公式。 null返回某些单元格将另存为数组公式,而某些单元格将不保存为数组公式。

savedAsArray?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.12

style

对于集合中的每个项目: 表示当前范围的样式。 如果单元格的样式不一致, null 将返回。 对于自定义样式,将返回样式名称。 对于内置样式,将返回表示枚举中 BuiltInStyle 值的字符串。

style?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.7

text

对于集合中的每个项目: 指定区域的文本值。 文本值与单元格宽度无关。 Excel UI 中发生的数字符号 (#) 替换不会影响 API 返回的文本值。

text?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.1

top

对于集合中的每个项:返回对于 100% 缩放的从工作表顶部边缘到范围顶部边缘的距离(以磅为单位)。

top?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.10

values

For EACH ITEM in the collection: 表示指定区域的原始值。 返回的数据可以是字符串、数字或布尔值。 包含错误的单元格将返回错误字符串。 如果返回的值以加号 (“+”) 开头、减号 (“-”) 或等号 (“=”) ,Excel 会将此值解释为公式。

values?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.1

valuesAsJson

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

valuesAsJson?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.16

valuesAsJsonLocal

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

valuesAsJsonLocal?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.16

valueTypes

对于集合中的每个项: 指定每个单元格中的数据类型。

valueTypes?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.1

width

对于集合中的每个项目:返回从范围左边缘到范围右边缘的距离(以 100% 缩放为单位)。

width?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.10

worksheet

对于集合中的每个项:包含当前范围的工作表。

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

属性值

注解

API 集:ExcelApi 1.9