Excel.NamedItemArrayValues class

包:

excel

表示包含命名项的值和类型的对象。

扩展

OfficeExtension.ClientObject

注解

API 集：ExcelApi 1.7

使用方

• Excel.NamedItem： arrayValues

属性

context	与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。
types	表示命名项目数组中每个项目的类型
values	表示已命名项目数组中每个项目的值。
valuesAsJson	此命名项数组中值的 JSON 表示形式。 与 不同， NamedItemArrayValues.values支持 NamedItemArrayValues.valuesAsJson 可以在单元格中的所有数据类型。 示例包括格式化数字值和 Web 图像，以及标准布尔值、数字和字符串值。 从此 API 返回的数据始终与 en-US 区域设置一致。 要检索用户显示区域设置中的数据，请使用 NamedItemArrayValues.valuesAsJsonLocal。
valuesAsJsonLocal	此命名项数组中值的 JSON 表示形式。 与 不同， NamedItemArrayValues.values支持 NamedItemArrayValues.valuesAsJsonLocal 可以在单元格中的所有数据类型。 示例包括格式化数字值和 Web 图像，以及标准布尔值、数字和字符串值。 从此 API 返回的数据始终与用户的显示区域设置一致。 要检索独立于区域设置的数据，请使用 NamedItemArrayValues.valuesAsJson。

方法

load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
toJSON()	覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.NamedItemArrayValues 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Excel.Interfaces.NamedItemArrayValuesData) ，其中包含从原始对象加载的任何子属性的浅层副本。

属性详细信息

context

与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

Excel.RequestContext

types

表示命名项目数组中每个项目的类型

readonly types: Excel.RangeValueType[][];

属性值

Excel.RangeValueType[][]

注解

API 集：ExcelApi 1.7

values

表示已命名项目数组中每个项目的值。

readonly values: any[][];

属性值

any[][]

注解

API 集：ExcelApi 1.7

valuesAsJson

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

readonly valuesAsJson: CellValue[][];

属性值

Excel.CellValue[][]

注解

API 集：ExcelApi 1.16

valuesAsJsonLocal

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

readonly valuesAsJsonLocal: CellValue[][];

属性值

Excel.CellValue[][]

注解

API 集：ExcelApi 1.16

方法详细信息

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: Excel.Interfaces.NamedItemArrayValuesLoadOptions): Excel.NamedItemArrayValues;

参数

options

Excel.Interfaces.NamedItemArrayValuesLoadOptions

为要加载的对象属性提供选项。

返回

Excel.NamedItemArrayValues

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNames?: string | string[]): Excel.NamedItemArrayValues;

参数

propertyNames

string | string[]

指定要加载的属性的逗号分隔的字符串或字符串数组。

返回

Excel.NamedItemArrayValues

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.NamedItemArrayValues;

参数

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。

返回

Excel.NamedItemArrayValues

toJSON()

覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.NamedItemArrayValues 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Excel.Interfaces.NamedItemArrayValuesData) ，其中包含从原始对象加载的任何子属性的浅层副本。

toJSON(): Excel.Interfaces.NamedItemArrayValuesData;

返回

Excel.Interfaces.NamedItemArrayValuesData