OfficeExtension.ClientRequestContext class

Paket:

office

Ein abstraktes RequestContext-Objekt, das Anforderungen an die Office-Anwendung erleichtert. Die Excel.run Methoden und Word.run stellen einen Anforderungskontext bereit.

Konstruktoren

(constructor)(url)

Erstellt eine neue Instanz der ClientRequestContext -Klasse

Eigenschaften

debugInfo	Debuginformationen
requestHeaders	Anforderungsheader
trackedObjects	Sammlung von Objekten, die für automatische Anpassungen basierend auf umgebenden Änderungen im Dokument nachverfolgt werden.

Methoden

load(object, option)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
loadRecursive(object, options, maxDepth)	Stellt einen Befehl in die Warteschlange, um die angegebenen Eigenschaften des Objekts und seiner Navigationseigenschaften rekursiv zu laden. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
sync(passThroughValue)	Synchronisiert den Zustand zwischen JavaScript-Proxyobjekten und dem Office-Dokument, indem Anweisungen ausgeführt werden, die für den Anforderungskontext in die Warteschlange eingereiht werden, und Eigenschaften von geladenen Office-Objekten zur Verwendung in Ihrem Code abgerufen werden. Diese Methode gibt eine Zusage zurück, die nach Abschluss der Synchronisierung aufgelöst wird.
trace(message)	Fügt der Warteschlange eine Ablaufverfolgungsmeldung hinzu. Wenn die von context.sync() zurückgegebene Zusage aufgrund eines Fehlers abgelehnt wird, wird dem OfficeExtension.Error-Objekt ein Array ".traceMessages" hinzugefügt, das alle ausgeführten Ablaufverfolgungsmeldungen enthält. Diese Meldungen können Ihnen helfen, die Programmausführungssequenz zu überwachen und die Ursache des Fehlers zu erkennen.

Details zum Konstruktor

(constructor)(url)

Erstellt eine neue Instanz der ClientRequestContext -Klasse

constructor(url?: string);

Parameter

url

string

Details zur Eigenschaft

debugInfo

Debuginformationen

readonly debugInfo: RequestContextDebugInfo;

Eigenschaftswert

OfficeExtension.RequestContextDebugInfo

requestHeaders

Anforderungsheader

requestHeaders: { [name: string]: string };

Eigenschaftswert

{ [name: string]: string }

trackedObjects

Sammlung von Objekten, die für automatische Anpassungen basierend auf umgebenden Änderungen im Dokument nachverfolgt werden.

trackedObjects: TrackedObjects;

Eigenschaftswert

OfficeExtension.TrackedObjects

Details zur Methode

load(object, option)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(object: ClientObject, option?: string | string[] | LoadOption): void;

Parameter

object

OfficeExtension.ClientObject

Das Objekt, dessen Eigenschaften geladen werden.

option

string | string[] | OfficeExtension.LoadOption

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angibt, oder ein OfficeExtension.LoadOption-Objekt .

Gibt zurück

void

loadRecursive(object, options, maxDepth)

Stellt einen Befehl in die Warteschlange, um die angegebenen Eigenschaften des Objekts und seiner Navigationseigenschaften rekursiv zu laden.

Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

loadRecursive(object: ClientObject, options: { [typeName: string]: string | string[] | LoadOption }, maxDepth?: number): void;

Parameter

object

OfficeExtension.ClientObject

Das zu ladende Objekt.

options

{ [typeName: string]: string | string[] | OfficeExtension.LoadOption }

Die Schlüssel-Wert-Paarung von Ladeoptionen für die Typen, z. B. { "Workbook": "worksheets,tables", "Worksheet": "tables", "Tables": "name" }

maxDepth

number

Die maximale rekursive Tiefe.

Gibt zurück

void

sync(passThroughValue)

Synchronisiert den Zustand zwischen JavaScript-Proxyobjekten und dem Office-Dokument, indem Anweisungen ausgeführt werden, die für den Anforderungskontext in die Warteschlange eingereiht werden, und Eigenschaften von geladenen Office-Objekten zur Verwendung in Ihrem Code abgerufen werden. Diese Methode gibt eine Zusage zurück, die nach Abschluss der Synchronisierung aufgelöst wird.

sync<T>(passThroughValue?: T): Promise<T>;

Parameter

passThroughValue

T

Gibt zurück

Promise<T>

trace(message)

Fügt der Warteschlange eine Ablaufverfolgungsmeldung hinzu. Wenn die von context.sync() zurückgegebene Zusage aufgrund eines Fehlers abgelehnt wird, wird dem OfficeExtension.Error-Objekt ein Array ".traceMessages" hinzugefügt, das alle ausgeführten Ablaufverfolgungsmeldungen enthält. Diese Meldungen können Ihnen helfen, die Programmausführungssequenz zu überwachen und die Ursache des Fehlers zu erkennen.

trace(message: string): void;

Parameter

message

string

Gibt zurück

void