Excel.FunctionResult class

Package:

excel

An object containing the result of a function-evaluation operation

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.2 ]

Properties

context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
error	Error value (such as "#DIV/0") representing the error. If the error string is not set, then the function succeeded, and its result is written to the Value field. The error is always in the English locale.
value	The value of function evaluation. The value field will be populated only if no error has occurred (i.e., the Error property is not set).

Methods

load(options)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
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 is passed to it.) Whereas the original FunctionResult<T> object is an API object, the toJSON method returns a plain JavaScript object (typed as Interfaces.FunctionResultData<T>) that contains shallow copies of any loaded child properties from the original object.

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

Excel.RequestContext

error

Error value (such as "#DIV/0") representing the error. If the error string is not set, then the function succeeded, and its result is written to the Value field. The error is always in the English locale.

readonly error: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.2 ]

value

The value of function evaluation. The value field will be populated only if no error has occurred (i.e., the Error property is not set).

readonly value: T;

Property Value

T

Remarks

[ API set: ExcelApi 1.2 ]

Method Details

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

options

Excel.Interfaces.FunctionResultLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.FunctionResult<T>

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[]): FunctionResult<T>;

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

Excel.FunctionResult<T>

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;
        }): FunctionResult<T>;

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

Excel.FunctionResult<T>

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 is passed to it.) Whereas the original FunctionResult<T> object is an API object, the toJSON method returns a plain JavaScript object (typed as Interfaces.FunctionResultData<T>) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Interfaces.FunctionResultData<T>;

Returns

Excel.Interfaces.FunctionResultData<T>