Excel.FunctionResult class

  • Referencia
Paquete:
excel

Objeto que contiene el resultado de una operación de evaluación de funciones

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

Propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
error

Valor de error (como "#DIV/0") que representa el error. Si no se establece la cadena de error, la función se realizó correctamente y su resultado se escribe en el campo Valor. El error siempre está en la configuración regional en inglés.
value

Valor de la evaluación de funciones. El campo de valor solo se rellenará si no se ha producido ningún error (es decir, no se establece la propiedad Error).

Métodos

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original FunctionResult<T> es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Interfaces.FunctionResultData<T>) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Excel.RequestContext

error

Valor de error (como "#DIV/0") que representa el error. Si no se establece la cadena de error, la función se realizó correctamente y su resultado se escribe en el campo Valor. El error siempre está en la configuración regional en inglés.

readonly error: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

value

Valor de la evaluación de funciones. El campo de valor solo se rellenará si no se ha producido ningún error (es decir, no se establece la propiedad Error).

readonly value: T;

Valor de propiedad

T

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

Detalles del método

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

options
Excel.Interfaces.FunctionResultLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Excel.FunctionResult<T>

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Excel.FunctionResult<T>

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Excel.FunctionResult<T>

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original FunctionResult<T> es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Interfaces.FunctionResultData<T>) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Interfaces.FunctionResultData<T>;

Devoluciones

Excel.Interfaces.FunctionResultData<T>