Freigeben über

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
Body shapes Ruft die Auflistung von Shape-Objekten im Text ab, einschließlich Inline- und unverankerten Formen.
type Ruft den Typ des Texts ab.
Leinwand id Ruft eine ganze Zahl ab, die den Canvas-Bezeichner darstellt.
shape Ruft das Shape-Objekt ab, das dem Zeichenbereich zugeordnet ist.
shapes Ruft die Auflistung von Shape-Objekten ab.
ContentControl resetState() Setzt den Zustand des Inhaltssteuerelements zurück.
setState(contentControlState: Word. ContentControlState) Legt den Status des Inhaltssteuerelements fest.
ContentControlAddedEventArgs eventType Der Ereignistyp.
ContentControlDataChangedEventArgs eventType Der Ereignistyp.
ContentControlDeletedEventArgs eventType Der Ereignistyp.
ContentControlEnteredEventArgs eventType Der Ereignistyp.
ContentControlExitedEventArgs eventType Der Ereignistyp.
ContentControlSelectionChangedEventArgs eventType Der Ereignistyp.
Dokument activeWindow Ruft das aktive Fenster für das Dokument ab.
compareFromBase64(base64File: string, documentCompareOptions?: Word. DocumentCompareOptions) Zeigt Korrekturmarkierungen an, um hervorzuheben, an welchen Stellen das angegebene Dokument von einem anderen abweicht.
Fenster Ruft die Auflistung von Word.Window -Objekten für das Dokument ab.
Font hidden Gibt einen Wert an, der angibt, ob die Schriftart als ausgeblendet gekennzeichnet ist.
InsertShapeOptions height Stellt die Höhe der einzufügenden Form dar.
left Stellt die linke Position der einzufügenden Form dar.
top Stellt die oberste Position der einzufügenden Form dar.
width Stellt die Breite der einzufügenden Form dar.
Page getNext() Ruft die nächste Seite im Bereich ab.
getNextOrNullObject() Ruft die nächste Seite ab.
getRange(rangeLocation?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | "Ganz" | "Start" | "Ende") Ruft die gesamte Seite oder den Start- oder Endpunkt der Seite als Bereich ab.
height Ruft die Höhe des im Dialogfeld Seite einrichten definierten Papiers in Punkt ab.
Index Ruft den Index der Seite ab.
width Ruft die Breite des im Dialogfeld Seite einrichten definierten Papiers in Punkt ab.
PageCollection getFirst() Ruft die erste Seite in dieser Auflistung ab.
getFirstOrNullObject() Ruft die erste Seite in dieser Auflistung ab.
getItem(index: number) Ruft ein Page-Objekt anhand seines Indexes in der Auflistung ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
Fensterausschnitt getNext() Ruft den nächsten Bereich im Fenster ab.
getNextOrNullObject() Ruft den nächsten Bereich ab.
pages Ruft die Auflistung der Seiten im Bereich ab.
pagesEnclosingViewport Ruft die PageCollection im Viewport des Bereichs angezeigte ab.
PaneCollection getFirst() Ruft den ersten Bereich in dieser Auflistung ab.
getFirstOrNullObject() Ruft den ersten Bereich in dieser Auflistung ab.
getItem(index: number) Ruft ein Pane-Objekt anhand seines Indexes in der Auflistung ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
Paragraph insertCanvas(insertShapeOptions?: Word. InsertShapeOptions) Fügt einen unverankerten Zeichenbereich vor text mit seinem Anker am Anfang des Absatzes ein.
insertGeometricShape(geometricShapeType: Word. GeometricShapeType, insertShapeOptions?: Word. InsertShapeOptions) Fügt eine geometrische Form vor text mit ihrem Anker am Anfang des Absatzes ein.
insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word. InsertShapeOptions) Fügt ein unverankertes Bild vor Text ein, dessen Anker am Anfang des Absatzes steht.
insertTextBox(text?: string, insertShapeOptions?: Word. InsertShapeOptions) Fügt ein unverankertes Textfeld vor text mit seinem Anker am Anfang des Absatzes ein.
shapes Ruft die Auflistung der im Absatz verankerten Shape-Objekte ab, einschließlich inline- und unverankerter Formen.
ParagraphAddedEventArgs type Der Ereignistyp.
ParagraphChangedEventArgs type Der Ereignistyp.
ParagraphDeletedEventArgs type Der Ereignistyp.
Range insertCanvas(insertShapeOptions?: Word. InsertShapeOptions) Fügt einen unverankerten Zeichenbereich vor Text ein, dessen Anker am Anfang des Bereichs steht.
insertGeometricShape(geometricShapeType: Word. GeometricShapeType, insertShapeOptions?: Word. InsertShapeOptions) Fügt eine geometrische Form vor Text ein, deren Anker am Anfang des Bereichs steht.
insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word. InsertShapeOptions) Fügt ein unverankertes Bild vor text mit seinem Anker am Anfang des Bereichs ein.
insertTextBox(text?: string, insertShapeOptions?: Word. InsertShapeOptions) Fügt ein unverankertes Textfeld vor text mit seinem Anker am Anfang des Bereichs ein.
pages Ruft die Auflistung der Seiten im Bereich ab.
shapes Ruft die Auflistung der im Bereich verankerten Shape-Objekte ab, einschließlich inline- und unverankerter Formen.
Shape Text Stellt das Body-Objekt der Form dar.
Leinwand Ruft den Canvas ab, der der Form zugeordnet ist.
delete() Löscht die Form und ihren Inhalt.
fill Gibt die Füllungsformatierung dieser Form zurück.
geometricShapeType Der geometrische Formtyp der Form.
height Die Höhe der Form in Punkt.
id Ruft eine ganze Zahl ab, die den Shape-Bezeichner darstellt.
isChild Überprüfen Sie, ob es sich bei diesem Shape um ein untergeordnetes Element einer Gruppenform oder einer Canvas-Form handelt.
left Der Abstand (in Punkt) von der linken Seite der Form zur horizontalen relativen Position finden Sie unter Word. RelativeHorizontalPosition.
moveHorizontally(distance: number) Verschiebt das Shape horizontal um die Anzahl der Punkte.
moveVertically(distance: number) Verschiebt die Form vertikal um die Anzahl der Punkte.
name Der Name der Form.
parentCanvas Ruft die übergeordnete Canvas-Form der obersten Ebene dieser untergeordneten Form ab.
parentGroup Ruft die übergeordnete Gruppenform der obersten Ebene dieser untergeordneten Form ab.
relativeHorizontalPosition Die relative horizontale Position der Form.
relativeVerticalPosition Die relative vertikale Position der Form.
select(selectMultipleShapes?: boolean) Wählt die Form aus.
shapeGroup Ruft die shape-Gruppe ab, die der Form zugeordnet ist.
textFrame Ruft das Textrahmenobjekt der Form ab.
top Der Abstand in Punkt vom oberen Rand der Form zur vertikalen relativen Position finden Sie unter Word. RelativeVerticalPosition.
type Ruft den Formtyp ab.
width Die Breite der Form in Punkt.
ShapeCollection getByGeometricTypes(types: Word. GeometricShapeType[]) Ruft die Shapes ab, die über die angegebenen geometrischen Typen verfügen.
getById(id: number) Ruft ein Shape anhand seines Bezeichners ab.
getByIdOrNullObject(id: number) Ruft ein Shape anhand seines Bezeichners ab.
getByIds(ids: number[]) Ruft die Shapes nach Bezeichnern ab.
getByNames(names: string[]) Ruft die Shapes ab, die über die angegebenen Namen verfügen.
getByTypes(types: Word. ShapeType[]) Ruft die Shapes ab, die über die angegebenen Typen verfügen.
getFirst() Ruft die erste Form in dieser Auflistung ab.
getFirstOrNullObject() Ruft die erste Form in dieser Auflistung ab.
group() Gruppiert unverankerte Shapes in dieser Auflistung. Inline-Shapes werden übersprungen.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
ShapeFill backgroundColor Gibt die Hintergrundfarbe der Formfüllung an.
clear() Löscht die Füllformatierung dieser Form und legt sie auf Word.ShapeFillType.NoFillfest.
foregroundColor Gibt die Vordergrundfarbe der Formfüllung an.
setSolidColor(color: string) Legt die Füllungsformatierung der Form auf einfarbige Füllung fest.
transparency Gibt den Transparenzprozentsatz der Füllung als Wert von 0,0 (undurchsichtig) bis 1,0 (klar) an.
type Gibt den Füllungstyp der Form zurück.
ShapeGroup id Ruft eine ganze Zahl ab, die den Shape-Gruppenbezeichner darstellt.
shape Ruft das Shape-Objekt ab, das der Gruppe zugeordnet ist.
shapes Ruft die Auflistung von Shape-Objekten ab.
ungroup() Hebt die Gruppierung von gruppierten Formen in der angegebenen Formgruppe auf.
Style description Ruft die Beschreibung des angegebenen Stils ab.
TextFrame autoSizeSetting Die Einstellungen für die automatische Größenanpassung für den Textrahmen.
bottomMargin Stellt den unteren Rand des Textrahmens in Punkt dar.
hasText Gibt an, ob der Textrahmen Text enthält.
leftMargin Stellt den linken Rand des Textrahmens in Punkt dar.
noTextRotation Gibt True zurück, wenn der Text im Textrahmen nicht gedreht werden soll, wenn die Form gedreht wird.
orientation Stellt den Winkel dar, an dem der Text für den Textrahmen ausgerichtet ist.
rightMargin Stellt den rechten Rand des Textrahmens in Punkt dar.
topMargin Stellt den oberen Rand des Textrahmens in Punkt dar.
verticalAlignment Stellt die vertikale Ausrichtung des Textrahmens dar.
wordWrap Bestimmt, ob Zeilen automatisch umbrechen, um Text in die Form einzupassen.
Window activePane Ruft den aktiven Bereich im Fenster ab.
Scheiben Ruft die Auflistung der Bereiche im Fenster ab.
WindowCollection getFirst() Ruft das erste Fenster in dieser Auflistung ab.
getFirstOrNullObject() Ruft das erste Fenster in dieser Auflistung ab.
getItem(index: number) Ruft ein Window-Objekt anhand seines Indexes in der Auflistung ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

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