Partager via

Excel.FunctionResult class

  • Référence
Paquet:
excel

Objet contenant le résultat d’une opération d’évaluation de fonction

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

Propriétés

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
error

Valeur d’erreur (telle que « #DIV/0 ») représentant l’erreur. Si la chaîne d’erreur n’est pas définie, la fonction a réussi et son résultat est écrit dans le champ Valeur. L’erreur se trouve toujours dans les paramètres régionaux anglais.
value

Valeur de l’évaluation de la fonction. Le champ de valeur est rempli uniquement si aucune erreur ne s’est produite (c’est-à-dire que la propriété Error n’est pas définie).

Méthodes

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine FunctionResult<T> est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Interfaces.FunctionResultData<T>que ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

Détails de la propriété

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Excel.RequestContext

error

Valeur d’erreur (telle que « #DIV/0 ») représentant l’erreur. Si la chaîne d’erreur n’est pas définie, la fonction a réussi et son résultat est écrit dans le champ Valeur. L’erreur se trouve toujours dans les paramètres régionaux anglais.

readonly error: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

value

Valeur de l’évaluation de la fonction. Le champ de valeur est rempli uniquement si aucune erreur ne s’est produite (c’est-à-dire que la propriété Error n’est pas définie).

readonly value: T;

Valeur de propriété

T

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

Détails de la méthode

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

options
Excel.Interfaces.FunctionResultLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.FunctionResult<T>

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Excel.FunctionResult<T>

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

propertyNamesAndPaths

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

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Excel.FunctionResult<T>

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine FunctionResult<T> est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Interfaces.FunctionResultData<T>que ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Interfaces.FunctionResultData<T>;

Retours

Excel.Interfaces.FunctionResultData<T>