Excel.CustomFunctionManager class

管理自定义函数上的设置。

扩展

注解

[ API 集:ExcelApi 1.20 ]

属性

context

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

方法

load(propertyNames)

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

load(propertyNamesAndPaths)

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

newObject(context)

创建 对象的新实例 Excel.CustomFunctionManager

setVisibility(customFunctionVisibilityOptions)

在 Excel 自动完成中显示或隐藏自定义函数。

toJSON()

重写 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (,依次调用toJSON传递给它的 对象的 方法。) 虽然原始Excel.CustomFunctionManager对象是 API 对象,toJSON但该方法返回一个纯 JavaScript 对象, (类型为 Excel.Interfaces.CustomFunctionManagerData) ,其中包含从原始对象加载的任何子属性的浅表副本。

属性详细信息

context

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

context: RequestContext;

属性值

方法详细信息

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

newObject(context)

创建 对象的新实例 Excel.CustomFunctionManager

static newObject(context: OfficeExtension.ClientRequestContext): Excel.CustomFunctionManager;

参数

返回

注解

[ API 集:ExcelApi 1.20 ]

setVisibility(customFunctionVisibilityOptions)

在 Excel 自动完成中显示或隐藏自定义函数。

static setVisibility(customFunctionVisibilityOptions: Excel.CustomFunctionVisibilityOptions): void;

参数

customFunctionVisibilityOptions
Excel.CustomFunctionVisibilityOptions

指定要显示或隐藏的自定义函数。

返回

void

注解

[ API 集:ExcelApi 1.20 ]

toJSON()

重写 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (,依次调用toJSON传递给它的 对象的 方法。) 虽然原始Excel.CustomFunctionManager对象是 API 对象,toJSON但该方法返回一个纯 JavaScript 对象, (类型为 Excel.Interfaces.CustomFunctionManagerData) ,其中包含从原始对象加载的任何子属性的浅表副本。

toJSON(): Excel.Interfaces.CustomFunctionManagerData;

返回