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 insertContentControl(contentControlType?: Word. ContentControlType.richText | Word. ContentControlType.plainText | Word. ContentControlType.checkBox | Word. ContentControlType.dropDownList | Word. ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox") Umschließt das Body-Objekt mit einem Inhaltssteuerelement.
ComboBoxContentControl addListItem(displayText: string, value?: string, index?: number) Fügt diesem Kombinationsfeld-Inhaltssteuerelement ein neues Listenelement hinzu und gibt eine Word zurück. ContentControlListItem-Objekt.
deleteAllListItems() Löscht alle Listenelemente in diesem Kombinationsfeld-Inhaltssteuerelement.
listItems Ruft die Auflistung von Listenelementen im Kombinationsfeld-Inhaltssteuerelement ab.
ContentControl comboBoxContentControl Gibt die Kombinationsfeld-bezogenen Daten an, wenn der Typ des Inhaltssteuerelements "ComboBox" ist.
dropDownListContentControl Gibt die dropdownlistenbezogenen Daten an, wenn der Typ des Inhaltssteuerelements "DropDownList" ist.
resetState() Setzt den Zustand des Inhaltssteuerelements zurück.
setState(contentControlState: Word. ContentControlState) Legt den Status des Inhaltssteuerelements fest.
ContentControlListItem delete() Löscht das Listenelement.
displayText Gibt den Anzeigetext eines Listenelements für ein Dropdownlisten- oder Kombinationsfeld-Inhaltssteuerelement an.
Index Gibt die Indexposition eines Inhaltssteuerelement-Listenelements in der Auflistung von Listenelementen an.
select() Wählt das Listenelement aus und legt den Text des Inhaltssteuerelements auf den Wert des Listenelements fest.
value Gibt den programmgesteuerten Wert eines Listenelements für ein Dropdownlisten- oder Kombinationsfeld-Inhaltssteuerelement an.
ContentControlListItemCollection getFirst() Ruft das erste Listenelement in dieser Auflistung ab.
getFirstOrNullObject() Ruft das erste Listenelement in dieser Auflistung ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
DropDownListContentControl addListItem(displayText: string, value?: string, index?: number) Fügt diesem Dropdownlisten-Inhaltssteuerelement ein neues Listenelement hinzu und gibt eine Word zurück. ContentControlListItem-Objekt.
deleteAllListItems() Löscht alle Listenelemente in diesem Dropdownlisten-Inhaltssteuerelement.
listItems Ruft die Auflistung von Listenelementen im Dropdownlisten-Inhaltssteuerelement ab.
Font hidden Gibt einen Wert an, der angibt, ob die Schriftart als ausgeblendet gekennzeichnet ist.
List 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.
Paragraph insertContentControl(contentControlType?: Word. ContentControlType.richText | Word. ContentControlType.plainText | Word. ContentControlType.checkBox | Word. ContentControlType.dropDownList | Word. ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox") Umschließt das Paragraph-Objekt mit einem Inhaltssteuerelement.
Range insertContentControl(contentControlType?: Word. ContentControlType.richText | Word. ContentControlType.plainText | Word. ContentControlType.checkBox | Word. ContentControlType.dropDownList | Word. ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox") Umschließt das Range-Objekt mit einem Inhaltssteuerelement.
Style description Ruft die Beschreibung des angegebenen Stils 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