Word JavaScript-Vorschau-APIs

  • Artikel

Neue Word JavaScript-APIs werden zuerst in der "Vorschau" eingeführt und später Teil eines bestimmten, nummerierten Anforderungssatzes, nachdem genügend Tests durchgeführt und Benutzerfeedback eingeholt wurde.

Wichtig

Beachten Sie, dass die folgenden Word Vorschau-APIs möglicherweise auf den folgenden Plattformen verfügbar sind.

  • Word unter Windows
  • Word für Mac

Word Vorschau-APIs werden auf dem iPad derzeit nicht unterstützt. Es können jedoch auch mehrere APIs in Word im Web verfügbar sein. Informationen zu APIs, die nur in Word im Web verfügbar sind, finden Sie in der Nur-Web-API-Liste.

Hinweis

Vorschau-APIs unterliegen Änderungen und können nicht für den Einsatz in Produktionsumgebungen vorgesehen werden. Wir empfehlen, sie nur in Test- und Entwicklungsumgebungen auszuprobieren. Verwenden Sie Vorschau-APIs nicht in einer Produktionsumgebung oder in unternehmenswichtigen Dokumenten.

So verwenden Sie Vorschau-APIs:

  • Sie müssen die Vorschauversion der Office JavaScript-API-Bibliothek aus dem Office.js Content Delivery Network (CDN) verwenden. Die Typdefinitionsdatei für die TypeScript-Kompilierung und IntelliSense finden Sie unter CDN und DefinitelyTyped. Sie können diese Typen mit npm install --save-dev @types/office-js-preview installieren (achten Sie darauf, die Typen für @types/office-js zu entfernen, wenn Sie sie zuvor installiert haben).
  • Möglicherweise müssen Sie am Microsoft 365 Insider-Programm teilnehmen, um Zugriff auf neuere Office-Builds zu erhalten.

API-Liste

In der folgenden Tabelle sind die Word JavaScript-APIs aufgeführt, die sich derzeit in der Vorschauphase befinden, mit Ausnahme der apIs, die nur in Word im Web verfügbar sind. Eine vollständige Liste aller Word JavaScript-APIs (einschließlich Vorschau-APIs und zuvor veröffentlichter APIs) finden Sie unter Alle Word JavaScript-APIs.

Klasse Felder Beschreibung
AnnotationPopupActionEventArgs action Gibt die ausgewählte Aktion im Popupmenü an.
kritikSuggestion Gibt den akzeptierten Vorschlag an (wird nur beim Akzeptieren eines Kritikvorschlags aufgefüllt).
id Gibt die Anmerkungs-ID an, für die das Ereignis ausgelöst wurde.
Border color Gibt die Farbe für den Rahmen an.
location Ruft die Position des Rahmens ab.
type Gibt den Rahmentyp für den Rahmen an.
visible Gibt an, ob der Rahmen sichtbar ist.
width Gibt die Breite für den Rahmen an.
BorderCollection getByLocation(borderLocation: Word.BorderLocation.top | Word. BorderLocation.left | Word. BorderLocation.bottom | Word. BorderLocation.right | Word. BorderLocation.insideHorizontal | Word. BorderLocation.insideVertical | "Top" | "Links" | "Unten" | "Rechts" | "InsideHorizontal" | "InsideVertical") Ruft den Rahmen ab, der die angegebene Position aufweist.
getFirst() Ruft den ersten Rahmen in dieser Auflistung ab.
getFirstOrNullObject() Ruft den ersten Rahmen in dieser Auflistung ab.
getItem(index: number) Ruft ein Border-Objekt anhand seines Indexes in der Auflistung ab.
insideBorderColor Gibt die 24-Bit-Farbe der inneren Rahmen an.
insideBorderType Gibt den Rahmentyp der Innenrahmen an.
insideBorderWidth Gibt die Breite der Innenrahmen an.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
outsideBorderColor Gibt die 24-Bit-Farbe der Außenrahmen an.
outsideBorderType Gibt den Rahmentyp der Außengrenzen an.
outsideBorderWidth Gibt die Breite der Außenränder an.
ContentControlAddedEventArgs eventType Der Ereignistyp.
ContentControlDataChangedEventArgs eventType Der Ereignistyp.
ContentControlDeletedEventArgs eventType Der Ereignistyp.
ContentControlEnteredEventArgs eventType Der Ereignistyp.
ContentControlEventArgs contentControl Das -Objekt, das das -Ereignis ausgelöst hat.
eventType Der Ereignistyp.
Ids Ruft die Inhaltssteuerelement-IDs ab.
source Die Quelle des Ereignisses.
ContentControlExitedEventArgs eventType Der Ereignistyp.
ContentControlSelectionChangedEventArgs eventType Der Ereignistyp.
Kritik popupOptions Gibt das Verhalten des Popupmenüs für die Kritik an.
CritiquePopupOptions brandingTextResourceId Ruft die Manifestressourcen-ID der Zeichenfolge ab, die für das Branding verwendet werden soll.
subtitleResourceId Ruft die Manifestressourcen-ID der Zeichenfolge ab, die als Untertitel verwendet werden soll.
Vorschläge Ruft die Vorschläge ab, die im Popupmenü Kritik angezeigt werden sollen.
titleResourceId Ruft die Manifestressourcen-ID der Zeichenfolge ab, die als Titel verwendet werden soll.
Dokument compare(filePath: string, documentCompareOptions?: Word. DocumentCompareOptions) Zeigt Korrekturmarkierungen an, um hervorzuheben, an welchen Stellen das angegebene Dokument von einem anderen abweicht.
onAnnotationPopupAction Tritt auf, wenn der Benutzer eine Aktion in einem Popupmenü für Anmerkungen ausführt.
DocumentCompareOptions addToRecentFiles Mit True wird das Dokument zur Liste der zuletzt verwendeten Dateien im Menü Datei hinzugefügt.
authorName Der Name des Bearbeiters, der den im Vergleich festgestellten Unterschieden zugeordnet ist.
compareTarget Das Zieldokument für den Vergleich.
detectFormatChanges True (Standardwert), wenn beim Vergleich auch Formatänderungen erkannt werden.
ignoreAllComparisonWarnings Mit True werden die Dokumente verglichen, ohne dass der Benutzer über Probleme benachrichtigt wird.
removeDateAndTime Mit True werden Datum und Zeitstempelangaben aus Überarbeitungen im zurückgegebenen Document-Objekt entfernt.
removePersonalInformation True entfernt alle Benutzerinformationen aus Kommentaren, Überarbeitungen und dem Eigenschaftendialogfeld im zurückgegebenen Document-Objekt.
Field showCodes Gibt an, ob die Feldfunktionen für das angegebene Feld angezeigt werden.
Font hidden Gibt einen Wert an, der angibt, ob die Schriftart als ausgeblendet gekennzeichnet ist.
InlinePicture Imageformat Ruft das Format des Inlinebilds ab.
List getLevelFont(level: number) Ruft die Schriftart des Aufzählungszeichens, der Zahl oder des Bilds auf der angegebenen Ebene in der Liste ab.
getLevelPicture(level: number) Ruft die Base64-codierte Zeichenfolgendarstellung der Grafik auf der angegebenen Ebene in der Liste ab.
resetLevelFont(level: number, resetFontName?: boolean) Setzt die Schriftart des Aufzählungszeichens, der Zahl oder des Bilds auf der angegebenen Ebene in der Liste zurück.
setLevelPicture(level: number, base64EncodedImage?: string) Legt das Bild auf der angegebenen Ebene in der Liste fest.
ListLevel Ausrichtung Gibt die horizontale Ausrichtung der Listenebene an.
font Ruft ein Font-Objekt ab, das die Zeichenformatierung des angegebenen Objekts darstellt.
linkedStyle Gibt den Namen der Formatvorlage an, die mit dem angegebenen Listenebenenobjekt verknüpft ist.
Numberformat Gibt das Zahlenformat für die angegebene Listenebene an.
numberPosition Gibt die Position (in Punkt) der Zahl oder des Aufzählungszeichens für das angegebene Listenebenenobjekt an.
numberStyle Gibt die Zahlenformatvorlage für das Listenebenenobjekt an.
resetOnHigher Gibt die Listenebene an, die angezeigt werden muss, bevor die angegebene Listenebene bei 1 neu gestartet wird.
Startat Gibt die Startnummer für das angegebene Listenebenenobjekt an.
tabPosition Gibt die Registerkartenposition für das angegebene Listenebenenobjekt an.
textPosition Gibt die Position (in Punkt) für die zweite Zeile des Umbruchtexts für das angegebene Listenebenenobjekt an.
trailingCharacter Gibt das Zeichen an, das nach der Zahl für die angegebene Listenebene eingefügt wird.
ListLevelCollection getFirst() Ruft die erste Listenebene in dieser Auflistung ab.
getFirstOrNullObject() Ruft die erste Listenebene in dieser Auflistung ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
ListTemplate listLevels Ruft eine ListLevels-Auflistung ab, die alle Ebenen für die angegebene ListTemplate darstellt.
outlineNumbered Gibt an, ob das angegebene ListTemplate-Objekt eine Gliederungsnummer hat.
ParagraphAddedEventArgs type Der Ereignistyp.
ParagraphChangedEventArgs type Der Ereignistyp.
ParagraphDeletedEventArgs type Der Ereignistyp.
Range highlight() Hebt den Bereich vorübergehend hervor, ohne den Dokumentinhalt zu ändern.
removeHighlight() Entfernt die hervorhebung, die von der Highlight-Funktion hinzugefügt wurde, falls vorhanden.
Shading foregroundPatternColor Gibt die Farbe für den Vordergrund des Objekts an.
Textur Gibt die Schattierungstextur des Objekts an.
Style borders Gibt ein BorderCollection-Objekt an, das alle Rahmen für die angegebene Formatvorlage darstellt.
description Ruft die Beschreibung des angegebenen Stils ab.
listTemplate Ruft ein ListTemplate-Objekt ab, das die Listenformatierung für das angegebene Style-Objekt darstellt.
TableRow insertContentControl() Fügt ein Inhaltssteuerelement in die Zeile ein.
TableStyle Ausrichtung Gibt die Ausrichtung der Tabelle am Seitenrand an.
allowBreakAcrossPage Gibt an, ob Zeilen in Tabellen, die mit einer angegebenen Formatvorlage formatiert sind, seitenübergreifend umbrechen.

Nur-Web-API-Liste

In der folgenden Tabelle sind die Word JavaScript-APIs aufgeführt, die sich derzeit nur in Word im Web in der Vorschauphase befinden. Eine vollständige Liste aller Word JavaScript-APIs (einschließlich Vorschau-APIs und zuvor veröffentlichter APIs) finden Sie unter Alle Word JavaScript-APIs.

Klasse Felder Beschreibung
Body onCommentAdded Tritt auf, wenn neue Kommentare hinzugefügt werden.
onCommentChanged Tritt auf, wenn ein Kommentar oder seine Antwort geändert wird.
onCommentDeleted Tritt auf, wenn Kommentare gelöscht werden.
onCommentDeselected Tritt auf, wenn ein Kommentar deaktiviert wird.
onCommentSelected Tritt auf, wenn ein Kommentar ausgewählt wird.
CommentDetail id Stellt die ID dieses Kommentars dar.
replyIds Stellt die IDs der Antworten auf diesen Kommentar dar.
CommentEventArgs changeType Stellt dar, wie das Kommentaränderungsereignis ausgelöst wird.
commentDetails Ruft das CommentDetail-Array ab, das die IDs und Antwort-IDs der beteiligten Kommentare enthält.
source Die Quelle des Ereignisses.
type Der Ereignistyp.
ContentControl onCommentAdded Tritt auf, wenn neue Kommentare hinzugefügt werden.
onCommentChanged Tritt auf, wenn ein Kommentar oder seine Antwort geändert wird.
onCommentDeselected Tritt auf, wenn ein Kommentar deaktiviert wird.
onCommentSelected Tritt auf, wenn ein Kommentar ausgewählt wird.
Paragraph onCommentAdded Tritt auf, wenn neue Kommentare hinzugefügt werden.
onCommentChanged Tritt auf, wenn ein Kommentar oder seine Antwort geändert wird.
onCommentDeleted Tritt auf, wenn Kommentare gelöscht werden.
onCommentDeselected Tritt auf, wenn ein Kommentar deaktiviert wird.
onCommentSelected Tritt auf, wenn ein Kommentar ausgewählt wird.
Range onCommentAdded Tritt auf, wenn neue Kommentare hinzugefügt werden.
onCommentChanged Tritt auf, wenn ein Kommentar oder seine Antwort geändert wird.
onCommentDeselected Tritt auf, wenn ein Kommentar deaktiviert wird.
onCommentSelected Tritt auf, wenn ein Kommentar ausgewählt wird.

Siehe auch