Excel.Interfaces.NamedItemCollectionLoadOptions interface

属于工作簿或工作表一部分的所有 NamedItem 对象的集合,具体取决于访问方式。

属性

$all

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

arrayValues

对于集合中的每个项目:返回包含命名项目的值和类型的对象。

comment

For EACH ITEM in the collection: 指定与此名称关联的注释。

formula

对于集合中的每个项:命名项的公式。 公式始终以等号 (“=”) 开头。

name

对于集合中的每个项目:对象的名称。

scope

对于集合中的每个项目:指定名称的范围是工作簿还是特定工作表。 可能的值为:工作表、工作簿。

type

For EACH ITEM in the collection: 指定名称公式返回的值的类型。 有关详细信息,请参阅 Excel.NamedItemType

value

For EACH ITEM in the collection: 表示由名称公式计算的值。 对于命名的范围,它将返回范围地址。 此 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

For EACH ITEM in the collection: 返回命名项目所限定的工作表。 如果项目的范围限定为工作簿,则此方法返回其 isNullObject 属性设置为 true的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

属性详细信息

$all

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

$all?: boolean;

属性值

boolean

arrayValues

对于集合中的每个项目:返回包含命名项目的值和类型的对象。

arrayValues?: Excel.Interfaces.NamedItemArrayValuesLoadOptions;

属性值

注解

API 集:ExcelApi 1.7

comment

For EACH ITEM in the collection: 指定与此名称关联的注释。

comment?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.4

formula

对于集合中的每个项:命名项的公式。 公式始终以等号 (“=”) 开头。

formula?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.7

name

对于集合中的每个项目:对象的名称。

name?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.1

scope

对于集合中的每个项目:指定名称的范围是工作簿还是特定工作表。 可能的值为:工作表、工作簿。

scope?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.4

type

For EACH ITEM in the collection: 指定名称公式返回的值的类型。 有关详细信息,请参阅 Excel.NamedItemType

type?: boolean;

属性值

boolean

注解

API 集: ExcelApi 1.1 for string,integer,double,Boolean,Range,Error;1.7 数组

value

For EACH ITEM in the collection: 表示由名称公式计算的值。 对于命名的范围,它将返回范围地址。 此 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;

属性值

注解

API 集:ExcelApi 1.4

worksheetOrNullObject

For EACH ITEM in the collection: 返回命名项目所限定的工作表。 如果项目的范围限定为工作簿,则此方法返回其 isNullObject 属性设置为 true的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

worksheetOrNullObject?: Excel.Interfaces.WorksheetLoadOptions;

属性值

注解

API 集:ExcelApi 1.4