Word Anforderungssatz 1.1 der JavaScript-API für Desktops

  • Artikel

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

Wenn APIs im Anforderungssatz WordApiDesktop plattformübergreifend unterstützt werden, werden sie dem nächsten veröffentlichten Anforderungssatz (WordApi 1.[NEXT]) hinzugefügt. Sobald dieser neue Anforderungssatz öffentlich ist, werden diese APIs auch weiterhin in diesem Anforderungssatz WordApiDesktop markiert.

Wichtig

WordApiDesktop 1.1 ist ein Nur-Desktop-Anforderungssatz. Es handelt sich um eine Obermenge der WordApi 1.8- und WordApiHiddenDocument 1.5-Anforderungssätze.

Da WordApiDesktop APIs nur von Word unter Windows, macos und auf iPad unterstützt werden, sollte Ihr Add-In überprüfen, ob der Anforderungssatz unterstützt wird, bevor diese APIs aufgerufen werden. Dadurch wird jeglicher Versuch vermieden, nur Desktop-APIs auf einer nicht unterstützten Plattform zu verwenden.

if (Office.context.requirements.isSetSupported("WordApiDesktop", "1.1")) {
   // Any API exclusive to the 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. Stellen Sie sicher, dass Sie das Feature auf diesen Plattformen testen, wenn Sie diese Änderung vornehmen.

Wichtig

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

API-Liste

In der folgenden Tabelle sind die Word JavaScript-APIs aufgeführt, die derzeit im Anforderungssatz WordApiDesktop 1.1 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 | "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.
Dokument compare(filePath: string, documentCompareOptions?: Word. DocumentCompareOptions) Zeigt Korrekturmarkierungen an, um hervorzuheben, an welchen Stellen das angegebene Dokument von einem anderen abweicht.
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.
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.
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.
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.
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.

Siehe auch