Excel.Interfaces.NamedItemData interface

一个描述通过调用 namedItem.toJSON()返回的数据的接口。

注解

使用方

属性

arrayValues

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

comment

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

formula

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

name

对象的名称。

scope

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

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

指定对象是否可见。

属性详细信息

arrayValues

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

arrayValues?: Excel.Interfaces.NamedItemArrayValuesData;

属性值

注解

API 集:ExcelApi 1.7

comment

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

comment?: string;

属性值

string

注解

API 集:ExcelApi 1.4

formula

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

formula?: any;

属性值

any

注解

API 集:ExcelApi 1.7

name

对象的名称。

name?: string;

属性值

string

注解

API 集:ExcelApi 1.1

scope

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

scope?: Excel.NamedItemScope | "Worksheet" | "Workbook";

属性值

Excel.NamedItemScope | "Worksheet" | "Workbook"

注解

API 集:ExcelApi 1.4

type

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

type?: Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array";

属性值

Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array"

注解

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

value

表示 name 公式计算出的值。 对于命名的范围,它将返回范围地址。 此 API 返回 #VALUE! 如果引用用户定义的函数,则会在 Excel UI 中显示错误。

value?: any;

属性值

any

注解

API 集:ExcelApi 1.1

valueAsJson

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

valueAsJson?: CellValue | string;

属性值

Excel.CellValue | string

注解

API 集:ExcelApi 1.16

valueAsJsonLocal

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

valueAsJsonLocal?: CellValue | string;

属性值

Excel.CellValue | string

注解

API 集:ExcelApi 1.16

visible

指定对象是否可见。

visible?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.1