Excel.Runtime class

Paquet:: excel

Représente la classe Excel Runtime.

Extends: OfficeExtension.ClientObject

Remarques

Utilisateur

Excel.RequestContext : runtime

Propriétés

context	Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
enableEvents	Activer/désactiver les événements JavaScript dans le volet Office ou le complément de contenu actif.

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.
set(properties, options)	Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.
set(properties)	Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
toJSON()	Remplace la méthode JavaScript `toJSON()` afin de fournir une sortie plus utile lorsqu’un objet API est passé à `JSON.stringify()`. (`JSON.stringify`, à son tour, appelle la `toJSON` méthode de l’objet qui lui est passé.) Alors que l’objet d’origine `Excel.Runtime` est un objet API, la `toJSON` méthode renvoie un objet JavaScript simple (typé ) `Excel.Interfaces.RuntimeData`qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

Détails de la propriété

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Excel.RequestContext

enableEvents

Activer/désactiver les événements JavaScript dans le volet Office ou le complément de contenu actif.

enableEvents: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.8

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-disable-events.yaml

await Excel.run(async (context) => {
    context.runtime.load("enableEvents");
    await context.sync();

    // check if events are enabled and toggle accordingly
    const eventBoolean = !context.runtime.enableEvents
    context.runtime.enableEvents = eventBoolean;
    if (eventBoolean) {
        console.log("Events are currently on.");
    } else {
        console.log("Events are currently off.");
    }

    await context.sync();
});

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.RuntimeLoadOptions): Excel.Runtime;

Paramètres

options: Excel.Interfaces.RuntimeLoadOptions

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

Retours

Excel.Runtime

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[]): Excel.Runtime;

Paramètres

propertyNames: string | string[]

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

Retours

Excel.Runtime

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;
        }): Excel.Runtime;

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.Runtime

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties: Interfaces.RuntimeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties: Excel.Interfaces.RuntimeUpdateData

Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux propriétés de l’objet sur lequel la méthode est appelée.

options: OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet de propriétés tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.Runtime): void;

Paramètres

properties: Excel.Runtime

Retours

void

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.Runtime est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.RuntimeDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.RuntimeData;

Retours

Excel.Interfaces.RuntimeData

Commentaires

Cette page a-t-elle été utile ?