Word JavaScript-API – nur Desktop-Anforderungssatz 1.1

Der WordApiDesktop Anforderungssatz ist ein spezieller Anforderungssatz, der Funktionen enthält, die nur für Word unter Windows, Mac und iPad verfügbar sind. APIs in diesem Anforderungssatz gelten als Produktions-APIs für die Word-Anwendung unter Windows, Mac und iPad. Sie befolgen die Supportrichtlinien von Microsoft 365 für Entwickler. WordApiDesktop APIs gelten als "Vorschau"-APIs für andere Plattformen (Web) und werden möglicherweise von keiner dieser Plattformen unterstützt.

Wenn APIs im WordApiDesktop Anforderungssatz auf allen Plattformen unterstützt werden, werden sie dem nächsten veröffentlichten Anforderungssatz hinzugefügt (WordApi 1.[NEXT]). Sobald dieser neue Anforderungssatz öffentlich ist, werden diese APIs auch weiterhin in diesem WordApiDesktop Anforderungssatz markiert. Weitere Informationen zu plattformspezifischen Anforderungen im Allgemeinen finden Sie unter Grundlegendes zu plattformspezifischen Anforderungssätzen.

Wichtig

WordApiDesktop 1.1 ist ein reiner Desktop-Anforderungssatz. Es ist eine Obermenge von WordApi 1.8.

Da die WordApiDesktop 1.1 APIs nur von Word unter Windows, Mac und iPad unterstützt werden, sollte Ihr Add-In prüfen, ob der Anforderungssatz unterstützt wird, bevor es diese APIs aufruft. Dadurch wird jeder Versuch vermieden, reine Desktop-APIs auf einer nicht unterstützten Plattform zu verwenden.

if (Office.context.requirements.isSetSupported("WordApiDesktop", "1.1")) {
   // Any API exclusive to this WordApiDesktop requirement set.
}

Sobald sich die API in einem plattformübergreifenden Anforderungssatz befindet, sollten Sie die isSetSupported Überprüfung entfernen oder bearbeiten. Dadurch wird das Feature Ihres Add-Ins auf anderen Plattformen aktiviert. Testen Sie das Feature unbedingt auf diesen Plattformen, wenn Sie diese Änderung vornehmen.

Wichtig

Ihr Manifest kann nicht als Aktivierungsanforderung angegeben werden WordApiDesktop 1.1 . Es ist kein gültiger Wert, der im Set-Element verwendet werden soll.

API-Liste

In der folgenden Tabelle sind die Word-JavaScript-APIs aufgeführt, die WordApiDesktop 1.1 derzeit im Anforderungssatz enthalten sind. Eine vollständige Liste aller Word-JavaScript-APIs (einschließlich WordApiDesktop 1.1 APIs und zuvor veröffentlichter APIs) finden Sie unter Alle Word-JavaScript-APIs.

Klasse Felder Beschreibung
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 | "Oben" | "Links" | "Unten" | "Richtig" | "InsideHorizontal" | "InsideVertical") Ruft den Rahmen ab, der die angegebene Position enthält.
getFirst() Erhält den ersten Rand in dieser Sammlung.
getFirstOrNullObject() Erhält den ersten Rand in dieser Sammlung.
getItem(index: number) Ruft ein Border Objekt anhand seines Index in der Auflistung ab.
insideBorderColor Gibt die 24-Bit-Farbe der Innenränder an.
insideBorderType Gibt den Rahmentyp der Innenränder an.
insideBorderWidth Gibt die Breite der Innenränder an.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
outsideBorderColor Gibt die 24-Bit-Farbe der Außenränder an.
outsideBorderType Gibt den Rahmentyp der Außenränder an.
outsideBorderWidth Gibt die Breite der Außenränder an.
Dokument compare(filePath: string, documentCompareOptions?: Word. DocumentCompareOptions) Zeigt Korrekturmarkierungen an, um hervorzuheben, an welchen Stellen das angegebene Dokument von einem anderen abweicht.
importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word. ImportedStylesConflictBehavior) Importieren von Formatvorlagen aus einer JSON-formatierten Zeichenfolge.
DocumentCompareOptions addToRecentFiles Gibt an, ob das Dokument der Liste der zuletzt verwendeten Dateien im Menü "Datei " hinzugefügt werden soll.
authorName Falls angegeben, gibt den Namen des Prüfers an, der den durch den Vergleich generierten Unterschieden zugeordnet ist.
compareTarget Falls angegeben, wird das Zieldokument für den Vergleich angegeben.
detectFormatChanges Gibt (falls angegeben) an, ob der Vergleich die Erkennung von Formatänderungen beinhalten soll.
ignoreAllComparisonWarnings Gibt (falls angegeben) an, ob die Dokumente verglichen werden sollen, ohne einen Benutzer über Probleme zu informieren.
removeDateAndTime Gibt an, ob Datums- und Zeitstempelinformationen aus nachverfolgten Änderungen im zurückgegebenen Document Objekt entfernt werden sollen.
removePersonalInformation Gibt an, ob alle Benutzerinformationen aus Kommentaren, Revisionen und dem Dialogfeld "Eigenschaften" im zurückgegebenen Document Objekt entfernt werden sollen.
Field showCodes Gibt an, ob Feldfunktionen für das angegebene Feld angezeigt werden.
InlinePicture imageFormat Ruft das Format des Inlinebilds ab.
List getLevelFont(level: number) Ruft die Schriftart des Aufzählungszeichens, der Nummer oder des Bilds auf der angegebenen Ebene in der Liste ab.
getLevelPicture(level: number) Ruft die Base64-codierte Zeichenfolgendarstellung des Bilds auf der angegebenen Ebene in der Liste ab.
resetLevelFont(level: number, resetFontName?: boolescher Wert) Setzt die Schriftart des Aufzählungszeichens, der Nummer 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 Objekts ListLevel darstellt.
linkedStyle Gibt den Namen der Formatvorlage an, die mit dem ListLevel Objekt verknüpft ist.
numberFormat Gibt das Zahlenformat für die Listenebene an.
numberPosition Gibt die Position (in Punkt) der Nummer oder des Aufzählungszeichens für das ListLevel Objekt an.
numberStyle Gibt das Zahlenformat für das ListLevel Objekt an.
resetOnHigher Gibt die Listenebene an, die angezeigt werden muss, bevor die Nummerierung bei 1 wieder beginnt.
startAt Gibt die Anfangsnummer für das ListLevel Objekt an.
tabPosition Gibt die Tabstoppposition für das ListLevel Objekt an.
textPosition Gibt die Position (in Punkt) für die zweite Zeile des Umbruchtexts für das ListLevel Objekt an.
trailingCharacter Gibt das Zeichen an, das nach der Zahl für die 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 ein ListLevelCollection Objekt ab, das alle Ebenen der Listenvorlage darstellt.
outlineNumbered Gibt an, ob die Listenvorlage eine Gliederungsnummer hat.
Shading foregroundPatternColor Gibt die Farbe für den Vordergrund des Objekts an.
Textur Gibt das Schattierungsmuster des Objekts an.
Style borders Gibt ein BorderCollection Objekt an, das alle Rahmen für die Formatvorlage darstellt.
listTemplate Ruft ein ListTemplate Objekt ab, das die Listenformatierung für die Formatvorlage 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 Formatvorlage formatiert sind, seitenübergreifend umbrechen.

Siehe auch

  • Last updated on