Excel.Interfaces.RangeLoadOptions interface

  • 参考
包:
excel

Range 表示一组或多个连续单元格，例如单元格、行、列或单元格块。 若要详细了解如何在整个 API 中使用区域，请从 Excel JavaScript API 中的范围开始。

注解

[ API 集：ExcelApi 1.1 ]

属性

$all

$all为 LoadOptions 指定将加载所有标量属性 (例如：Range.address) 但不加载导航属性 (例如： Range.format.fill.color) 。
address

指定 A1 样式中的区域引用。 地址值包含工作表引用 (例如“Sheet1！A1：B4“) 。
addressLocal

表示用户语言中指定范围的范围引用。
cellCount

指定区域中的单元格数。 如果单元格数超过 2^31-1 (2,147,483,647)，此 API 返回 -1。
columnCount

指定区域中的列总数。
columnHidden

表示当前范围中的所有列是否处于隐藏状态。 true当一个区域中的所有列都隐藏时，值。 false当区域中没有列处于隐藏状态时，该值为 。 null当某个区域中的某些列处于隐藏状态且不隐藏同一范围中的其他列时，该值表示。
columnIndex

指定区域中第一个单元格的列号。 从零开始编制索引。
format

返回一个格式对象，其中封装了区域的字体、填充、边框、对齐方式和其他属性。
formulas

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

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

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

表示当前区域中的所有单元格是否处于隐藏状态。 值是 true 隐藏区域中的所有单元格时。 false当区域中没有单元格被隐藏时，值。 null当某个区域中的某些单元格处于隐藏状态，而同一区域中的其他单元格未隐藏时，值表示。
numberFormat

表示给定区域的 Excel 数字格式代码。 有关 Excel 数字格式的详细信息，请参阅 数字格式代码。
rowCount

返回区域中的总行数。
rowHidden

表示当前范围中的所有行是否处于隐藏状态。 值是 true 隐藏范围中的所有行时。 false当区域中没有隐藏行时，值。 null当某个区域中的某些行处于隐藏状态且同一区域中的其他行未隐藏时，该值表示。
rowIndex

返回区域中第一个单元格的行编号。 从零开始编制索引。
text

指定区域的文本值。 文本值与单元格宽度无关。 Excel UI 中发生的数字符号 (#) 替换不会影响 API 返回的文本值。
values

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

指定每个单元格中的数据类型。
worksheet

包含当前区域的工作表。

属性详细信息

$all

$all为 LoadOptions 指定将加载所有标量属性 (例如：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

指定区域中的列总数。

columnCount?: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.1 ]

columnHidden

表示当前范围中的所有列是否处于隐藏状态。 true当一个区域中的所有列都隐藏时，值。 false当区域中没有列处于隐藏状态时，该值为 。 null当某个区域中的某些列处于隐藏状态且不隐藏同一范围中的其他列时，该值表示。

columnHidden?: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.2 ]

columnIndex

指定区域中第一个单元格的列号。 从零开始编制索引。

columnIndex?: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.1 ]

format

返回一个格式对象，其中封装了区域的字体、填充、边框、对齐方式和其他属性。

format?: Excel.Interfaces.RangeFormatLoadOptions;

属性值

Excel.Interfaces.RangeFormatLoadOptions

注解

[ API 集：ExcelApi 1.1 ]

formulas

表示采用 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

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

formulasR1C1?: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.2 ]

hidden

表示当前区域中的所有单元格是否处于隐藏状态。 值是 true 隐藏区域中的所有单元格时。 false当区域中没有单元格被隐藏时，值。 null当某个区域中的某些单元格处于隐藏状态，而同一区域中的其他单元格未隐藏时，值表示。

hidden?: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.2 ]

numberFormat

表示给定区域的 Excel 数字格式代码。 有关 Excel 数字格式的详细信息，请参阅 数字格式代码。

numberFormat?: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.1 ]

rowCount

返回区域中的总行数。

rowCount?: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.1 ]

rowHidden

表示当前范围中的所有行是否处于隐藏状态。 值是 true 隐藏范围中的所有行时。 false当区域中没有隐藏行时，值。 null当某个区域中的某些行处于隐藏状态且同一区域中的其他行未隐藏时，该值表示。

rowHidden?: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.2 ]

rowIndex

返回区域中第一个单元格的行编号。 从零开始编制索引。

rowIndex?: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.1 ]

text

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

text?: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.1 ]

values

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

values?: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.1 ]

valueTypes

指定每个单元格中的数据类型。

valueTypes?: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.1 ]

worksheet

包含当前区域的工作表。

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

属性值

Excel.Interfaces.WorksheetLoadOptions

注解

[ API 集：ExcelApi 1.1 ]