OfficeExtension.ClientRequestContext class
Objet RequestContext abstrait qui facilite les demandes adressées à l’application Office. Les Excel.run méthodes et Word.run fournissent un contexte de requête.
Constructeurs
| (constructor)(url) | Construit une nouvelle instance de la |
Propriétés
| debug |
Informations de débogage |
| request |
En-têtes de demande |
| tracked |
Collection d’objets suivis pour les ajustements automatiques en fonction des modifications environnantes dans le document. |
Méthodes
| load(object, option) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load |
Files d’attente une commande pour charger de manière récursive les propriétés spécifiées de l’objet et ses propriétés de navigation. Vous devez contacter |
| sync(pass |
Synchronise l’état entre les objets proxy JavaScript et le document Office, en exécutant les instructions mises en file d’attente sur le contexte de demande et en récupérant les propriétés des objets Office chargés à utiliser dans votre code. Cette méthode retourne une promesse, qui est résolue une fois la synchronisation terminée. |
| trace(message) | Ajoute un message de trace à la file d’attente. Si la promesse retournée par |
Détails du constructeur
(constructor)(url)
Construit une nouvelle instance de la ClientRequestContext classe
constructor(url?: string);Paramètres
- url
-
string
Détails de la propriété
debugInfo
Informations de débogage
readonly debugInfo: RequestContextDebugInfo;Valeur de propriété
requestHeaders
En-têtes de demande
requestHeaders: { [name: string]: string };Valeur de propriété
{ [name: string]: string }
trackedObjects
Collection d’objets suivis pour les ajustements automatiques en fonction des modifications environnantes dans le document.
trackedObjects: TrackedObjects;Valeur de propriété
Détails de la méthode
load(object, option)
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(object: ClientObject, option?: string | string[] | LoadOption): void;Paramètres
- object
- OfficeExtension.ClientObject
Objet dont les propriétés sont chargées.
- option
-
string | string[] | OfficeExtension.LoadOption
Chaîne délimitée par des virgules, ou tableau de chaînes, qui spécifie les propriétés à charger, ou objet OfficeExtension.LoadOption .
Retours
void
loadRecursive(object, options, maxDepth)
Files d’attente une commande pour charger de manière récursive les propriétés spécifiées de l’objet et ses propriétés de navigation.
Vous devez contacter context.sync() avant de lire les propriétés.
loadRecursive(object: ClientObject, options: { [typeName: string]: string | string[] | LoadOption }, maxDepth?: number): void;Paramètres
- object
- OfficeExtension.ClientObject
Objet à charger.
- options
-
{ [typeName: string]: string | string[] | OfficeExtension.LoadOption }
Le jumelage clé-valeur des options de chargement pour les types, tels que { "Workbook": "worksheets,tables", "Worksheet": "tables", "Tables": "name" }
- maxDepth
-
number
Profondeur récursive maximale.
Retours
void
sync(passThroughValue)
Synchronise l’état entre les objets proxy JavaScript et le document Office, en exécutant les instructions mises en file d’attente sur le contexte de demande et en récupérant les propriétés des objets Office chargés à utiliser dans votre code. Cette méthode retourne une promesse, qui est résolue une fois la synchronisation terminée.
sync<T>(passThroughValue?: T): Promise<T>;Paramètres
- passThroughValue
-
T
Retours
Promise<T>
trace(message)
Ajoute un message de trace à la file d’attente. Si la promesse retournée par context.sync() est rejetée en raison d’une erreur, cela ajoute un tableau « .traceMessages » à l’objet OfficeExtension.Error, contenant tous les messages de trace exécutés. Ces messages peuvent vous aider à surveiller la séquence d’exécution du programme et à détecter la cause de l’erreur.
trace(message: string): void;Paramètres
- message
-
string
Retours
void