Excel.FunctionResult class

包:

excel

包含函数计算操作结果的 对象

扩展

OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.2 ]

属性

context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
error	错误值 (，例如“#DIV/0”) 表示错误。 如果未设置错误字符串，则函数成功，其结果将写入 Value 字段。 错误始终位于英语区域设置中。
value	函数计算的值。 仅当 (未发生错误时，才会填充值字段，即未) 设置 Error 属性。

方法

load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
toJSON()	重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始FunctionResult<T>对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Interfaces.FunctionResultData<T>) ，其中包含原始对象中任何已加载子属性的浅表副本。

属性详细信息

context

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

context: RequestContext;

属性值

Excel.RequestContext

error

错误值 (，例如“#DIV/0”) 表示错误。 如果未设置错误字符串，则函数成功，其结果将写入 Value 字段。 错误始终位于英语区域设置中。

readonly error: string;

属性值

string

注解

[ API 集：ExcelApi 1.2 ]

value

函数计算的值。 仅当 (未发生错误时，才会填充值字段，即未) 设置 Error 属性。

readonly value: T;

属性值

T

注解

[ API 集：ExcelApi 1.2 ]

方法详细信息

load(options)

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

load(options?: Excel.Interfaces.FunctionResultLoadOptions): FunctionResult<T>;

参数

options

Excel.Interfaces.FunctionResultLoadOptions

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

返回

Excel.FunctionResult<T>

load(propertyNames)

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

load(propertyNames?: string | string[]): FunctionResult<T>;

参数

propertyNames

string | string[]

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

返回

Excel.FunctionResult<T>

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): FunctionResult<T>;

参数

propertyNamesAndPaths

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

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

返回

Excel.FunctionResult<T>

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始FunctionResult<T>对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Interfaces.FunctionResultData<T>) ，其中包含原始对象中任何已加载子属性的浅表副本。

toJSON(): Interfaces.FunctionResultData<T>;

返回

Excel.Interfaces.FunctionResultData<T>