Excel.FunctionResult class

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

扩展

注解

API 集:ExcelApi 1.2

使用方

属性

context

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

error

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

value

函数评估的值。 仅当未发生错误时,才会填充值字段 (即未) 设置“错误”属性。

方法

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;

属性值

error

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

readonly error: string;

属性值

string

注解

API 集:ExcelApi 1.2

value

函数评估的值。 仅当未发生错误时,才会填充值字段 (即未) 设置“错误”属性。

readonly value: T;

属性值

T

注解

API 集:ExcelApi 1.2

方法详细信息

load(options)

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

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

参数

options
Excel.Interfaces.FunctionResultLoadOptions

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

返回

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

toJSON()

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

toJSON(): Interfaces.FunctionResultData<T>;

返回