Excel.CustomFunctionManager class
Manages settings on custom functions.
- Extends
Remarks
Properties
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
Methods
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| new |
Create a new instance of the |
| set |
Show or hide custom functions in Excel AutoComplete. |
| toJSON() | Overrides the JavaScript |
Property Details
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
Method Details
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Excel.CustomFunctionManager;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.CustomFunctionManager;Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
newObject(context)
Create a new instance of the Excel.CustomFunctionManager object.
static newObject(context: OfficeExtension.ClientRequestContext): Excel.CustomFunctionManager;Parameters
Returns
Remarks
setVisibility(customFunctionVisibilityOptions)
Show or hide custom functions in Excel AutoComplete.
static setVisibility(customFunctionVisibilityOptions: Excel.CustomFunctionVisibilityOptions): void;Parameters
- customFunctionVisibilityOptions
- Excel.CustomFunctionVisibilityOptions
Specifies which custom functions to show or hide.
Returns
void
Remarks
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Excel.CustomFunctionManager object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.CustomFunctionManagerData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Excel.Interfaces.CustomFunctionManagerData;