Excel.Interfaces.NamedItemLoadOptions interface

  • 参考
包:
excel

表示单元格区域或值的定义名称。 名称可以是基元命名对象 (，如下面的类型) 、范围对象或对区域的引用所示。 此对象可用于获取与名称相关的 range 对象。

注解

[ API 集：ExcelApi 1.1 ]

属性

$all

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

返回包含已命名项目的值和类型的对象。
comment

指定与此名称关联的注释。
formula

命名项的公式。 公式始终以等号 (“=”) 开头。
name

对象的名称。
scope

指定名称的范围是工作簿还是特定工作表。 可能的值为：Worksheet、Workbook。
type

指定名称公式返回的值的类型。 有关详细信息，请参阅 Excel.NamedItemType。
value

表示 name 公式计算出的值。 对于命名区域，它将返回范围地址。 此 API 返回 #VALUE！ 如果 Excel UI 引用用户定义的函数，则为错误。
valueAsJson

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

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

指定对象是否可见。
worksheet

返回已命名项限定到的工作表。 如果项目的范围改为工作簿，则引发错误。
worksheetOrNullObject

返回指定项的范围所指向的工作表。 如果项目的范围改为工作簿，则此方法返回一个 对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。

属性详细信息

$all

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

$all?: boolean;

属性值

boolean

arrayValues

返回包含已命名项目的值和类型的对象。

arrayValues?: Excel.Interfaces.NamedItemArrayValuesLoadOptions;

属性值

Excel.Interfaces.NamedItemArrayValuesLoadOptions

注解

[ API 集：ExcelApi 1.7 ]

comment

指定与此名称关联的注释。

comment?: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.4 ]

formula

命名项的公式。 公式始终以等号 (“=”) 开头。

formula?: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.7 ]

name

对象的名称。

name?: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.1 ]

scope

指定名称的范围是工作簿还是特定工作表。 可能的值为：Worksheet、Workbook。

scope?: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.4 ]

type

指定名称公式返回的值的类型。 有关详细信息，请参阅 Excel.NamedItemType。

type?: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.1 for String，Integer，Double，Boolean，Range，Error;1.7 for Array ]

value

表示 name 公式计算出的值。 对于命名区域，它将返回范围地址。 此 API 返回 #VALUE！ 如果 Excel UI 引用用户定义的函数，则为错误。

value?: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.1 ]

valueAsJson

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

valueAsJson?: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.16 ]

valueAsJsonLocal

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

valueAsJsonLocal?: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.16 ]

visible

指定对象是否可见。

visible?: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.1 ]

worksheet

返回已命名项限定到的工作表。 如果项目的范围改为工作簿，则引发错误。

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

属性值

Excel.Interfaces.WorksheetLoadOptions

注解

[ API 集：ExcelApi 1.4 ]

worksheetOrNullObject

返回指定项的范围所指向的工作表。 如果项目的范围改为工作簿，则此方法返回一个 对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。

worksheetOrNullObject?: Excel.Interfaces.WorksheetLoadOptions;

属性值

Excel.Interfaces.WorksheetLoadOptions

注解

[ API 集：ExcelApi 1.4 ]