Word-JavaScript-API – nur Desktop-Anforderungssatz 1.2

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.2 ist ein reiner Desktop-Anforderungssatz. Es handelt sich um eine Obermenge von WordApi 1.9 und WordApiDesktop 1.1.

Da die WordApiDesktop 1.2 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.2")) {
   // 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.2 . 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.2 derzeit im Anforderungssatz enthalten sind. Eine vollständige Liste aller Word-JavaScript-APIs (einschließlich WordApiDesktop 1.2 APIs und zuvor veröffentlichter APIs) finden Sie unter Alle Word-JavaScript-APIs.

Klasse Felder Beschreibung
Body shapes Ruft die Sammlung der Shape Objekte im Textkörper ab, einschließlich Inline- und unverankerter Formen.
Leinwand id Ruft eine Ganzzahl ab, die den Canvas-Bezeichner darstellt.
shape Ruft das Shape dem Zeichenbereich zugeordnete Objekt ab.
shapes Ruft die Sammlung von Word ab. Gestalten von Objekten.
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 Sammlung der Word.Window Objekte für das Dokument ab.
Font hidden Gibt an, ob die Schriftart als ausgeblendet markiert ist.
InsertShapeOptions height Gibt (falls angegeben) die Höhe der einzufügenden Form an.
left Gibt (sofern angegeben) die linke Position der einzufügenden Form an.
top Gibt (sofern angegeben) die obere Position des eingefügten Shapes an.
width Gibt (sofern angegeben) die Breite der einzufügenden Form an.
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- und Endpunkt der Seite als Bereich ab.
height Ruft die Höhe des Papiers in Punkt ab, die im Dialogfeld Seite einrichten definiert ist.
Index Ruft den Index der Seite ab.
width Ruft die Breite (in Punkt) des Papiers ab, das im Dialogfeld Seite einrichten definiert ist.
PageCollection getFirst() Ruft die erste Seite in dieser Sammlung ab.
getFirstOrNullObject() Ruft die erste Seite in dieser Sammlung 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 Sammlung der Seiten im Bereich ab.
pagesEnclosingViewport Ruft das PageCollection im Ansichtsfenster des Bereichs angezeigte ab.
PaneCollection getFirst() Ruft den ersten Bereich in dieser Sammlung ab.
getFirstOrNullObject() Ruft den ersten Bereich in dieser Sammlung ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
Paragraph insertCanvas(insertShapeOptions?: Word. InsertShapeOptions) Fügt einen unverankerten Zeichenbereich vor dem Text mit seinem Anker am Anfang des Absatzes ein.
insertGeometricShape(geometricShapeType: Word. GeometricShapeType, insertShapeOptions?: Word. InsertShapeOptions) Fügt eine geometrische Form vor dem Text mit dem Anker am Anfang des Absatzes ein.
insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word. InsertShapeOptions) Fügt ein unverankertes Bild vor dem Text mit seinem Anker am Anfang des Absatzes ein.
insertTextBox(text?: string, insertShapeOptions?: Word. InsertShapeOptions) Fügt ein unverankertes Textfeld vor dem Text mit seinem Anker am Anfang des Absatzes ein.
shapes Ruft die Sammlung der im Absatz verankerten Shape Objekte ab, einschließlich Inline- und unverankerter Formen.
Range insertCanvas(insertShapeOptions?: Word. InsertShapeOptions) Fügt einen unverankerten Zeichenbereich vor dem Text mit seinem Anker am Anfang des Bereichs ein.
insertGeometricShape(geometricShapeType: Word. GeometricShapeType, insertShapeOptions?: Word. InsertShapeOptions) Fügt eine geometrische Form vor dem Text mit seinem Anker am Anfang des Bereichs ein.
insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word. InsertShapeOptions) Fügt ein unverankertes Bild vor dem Text mit seinem Anker am Anfang des Bereichs ein.
insertTextBox(text?: string, insertShapeOptions?: Word. InsertShapeOptions) Fügt ein unverankertes Textfeld vor dem Text mit seinem Anker am Anfang des Bereichs ein.
pages Ruft die Sammlung der Seiten im Bereich ab.
shapes Ruft die Sammlung der Shape Objekte ab, die im Bereich verankert sind, einschließlich Inline- und unverankerter Formen.
Shape allowOverlap Gibt an, ob ein bestimmtes Shape andere Shapes überlappen kann.
altTextDescription Gibt eine Zeichenfolge an, die den alternativen Text darstellt, der dem Shape zugeordnet ist.
Text Ruft das Body Objekt der Form ab.
Leinwand Ruft den mit der Form verknüpften Zeichenbereich ab.
delete() Löscht die Form und ihren Inhalt.
fill Gibt die Füllformatierung der Form zurück.
geometricShapeType Gibt den geometrischen Formtyp der Form an.
height Gibt die Höhe des Shapes in Punkten an.
heightRelative Gibt den prozentualen Anteil der Formhöhe an der relativen vertikalen Größe (d. h. die relativeVerticalSize Eigenschaft) an.
id Ruft eine Ganzzahl ab, die den Formbezeichner darstellt.
isChild Überprüfen Sie, ob dieses Shape einem Gruppen-Shape oder einem Canvas-Shape untergeordnet ist.
left Gibt den Abstand in Punkten von der linken Seite der Form zur relativen horizontalen Position (d. h. der relativeHorizontalPosition Eigenschaft) an.
leftRelative Gibt die relative linke Position als Prozentwert von der linken Seite der Form zur relativen horizontalen Position (d. h. die relativeHorizontalalPosition Eigenschaft) an.
lockAspectRatio Gibt an, ob das Seitenverhältnis dieses Shapes gesperrt ist.
moveHorizontally(distance: number) Verschiebt das Shape horizontal um die Anzahl der Punkte.
moveVertically(distance: number) Verschiebt das Shape um die Anzahl der Punkte vertikal.
name Gibt den Namen der Form an.
parentCanvas Ruft die übergeordnete Canvas-Form der obersten Ebene dieser untergeordneten Form ab.
parentGroup Ruft das Shape der übergeordneten Gruppe der obersten Ebene dieses untergeordneten Shapes ab.
relativeHorizontalPosition Gibt die relative horizontale Position der Form an.
relativeHorizontalSize Gibt die relative horizontale Größe des Shapes an.
relativeVerticalPosition Gibt die relative vertikale Position der Form an.
relativeVerticalSize Gibt die relative vertikale Größe der Form an.
rotation Gibt die Drehung der Form in Grad an.
scaleHeight(scaleFactor: number, scaleType: Word. ShapeScaleType, scaleFrom?: Word. ShapeScaleFrom) Skaliert die Höhe der Form anhand eines angegebenen Faktors.
scaleWidth(scaleFactor: number, scaleType: Word. ShapeScaleType, scaleFrom?: Word. ShapeScaleFrom) Skaliert die Breite der Form anhand eines angegebenen Faktors.
select(selectMultipleShapes?: boolescher Wert) Markiert die Form.
shapeGroup Ruft die mit dem Shape verknüpfte Formgruppe ab.
textFrame Ruft das TextFrame Objekt der Form ab.
textWrap Gibt die Textumbruchformatierung der Form zurück.
top Gibt den Abstand in Punkten vom oberen Rand der Form zur relativen vertikalen Position (d. h. der relativeVerticalPosition Eigenschaft) an.
topRelative Gibt die relative obere Position als Prozentsatz vom oberen Rand der Form bis zur relativen vertikalen Position (d. h. die relativeVerticalPosition Eigenschaft) an.
type Ruft den Formtyp ab.
visible Gibt an, ob das Shape sichtbar ist.
width Gibt die Breite des Shapes in Punkten an.
widthRelative Gibt den prozentualen Anteil der Formbreite an der relativen horizontalen Größe (d. h. die relativeHorizontalSize Eigenschaft) an.
ShapeCollection getByGeometricTypes(types: Word. GeometricShapeType[]) Ruft die Shapes ab, die die angegebenen geometrischen Typen aufweisen.
getById(id: number) Ruft eine Form anhand ihres Bezeichners ab.
getByIdOrNullObject(id: number) Ruft eine Form anhand ihres Bezeichners ab.
getByIds(ids: number[]) Ruft die Formen anhand der Bezeichner ab.
getByNames(names: string[]) Ruft die Shapes mit den angegebenen Namen ab.
getByTypes(types: Word. Formtyp[]) Ruft die Shapes mit den angegebenen Typen ab.
getFirst() Erhält die erste Form in dieser Sammlung.
getFirstOrNullObject() Erhält die erste Form in dieser Sammlung.
group() Gruppiert schwebende Formen in dieser Sammlung, Inline-Formen werden übersprungen.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
ShapeFill backgroundColor Legt die Hintergrundfarbe der Formfüllung fest.
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 zwischen 0,0 (undurchsichtig) und 1,0 (klar) an.
type Gibt den Füllungstyp der Form zurück.
ShapeGroup id Ruft eine Ganzzahl ab, die den Bezeichner der Formgruppe darstellt.
shape Ruft das Shape mit der Gruppe verknüpfte Objekt ab.
shapes Ruft die Sammlung von Shape Objekten ab.
ungroup() Hebt die Gruppierung von gruppierten Formen in der angegebenen Formgruppe auf.
ShapeTextWrap bottomDistance Gibt den Abstand (in Punkt) zwischen dem Dokumenttext und dem unteren Rand des textfreien Bereichs an, der die angegebene Form umgibt.
leftDistance Gibt den Abstand (in Punkt) zwischen dem Dokumenttext und dem linken Rand des textfreien Bereichs an, der die angegebene Form umgibt.
rightDistance Gibt den Abstand (in Punkt) zwischen dem Dokumenttext und dem rechten Rand des textfreien Bereichs an, der die angegebene Form umgibt.
Seite Gibt an, ob der Dokumenttext auf beiden Seiten des angegebenen Shapes angeordnet werden soll, entweder nur auf der linken oder rechten Seite oder auf der Seite des Shapes, die am weitesten vom Seitenrand entfernt ist.
topDistance Gibt den Abstand (in Punkt) zwischen dem Dokumenttext und dem oberen Rand des textfreien Bereichs an, der die angegebene Form umgibt.
type Gibt den Textumbruchtyp um die Form an.
TextFrame autoSizeSetting Gibt die automatischen Größeneinstellungen für den Textrahmen an.
bottomMargin Gibt den unteren Rand des Textrahmens in Punkt an.
hasText Gibt zurücktrue, wenn der Textrahmen Text enthält, andernfalls. false
leftMargin Gibt den linken Rand des Textrahmens in Punkt an.
noTextRotation Gibt an, ob sich der Text im Textrahmen nicht drehen soll, wenn die Form gedreht wird.
orientation Gibt den Winkel an, in dem der Text für den Textrahmen ausgerichtet ist.
rightMargin Gibt den rechten Rand des Textrahmens in Punkten an.
topMargin Gibt den oberen Rand des Textrahmens in Punkt an.
verticalAlignment Gibt die vertikale Ausrichtung des Textrahmens an.
wordWrap Bestimmt, ob Linien automatisch umgebrochen werden, damit Text in das Shape passt.
Window activePane Ruft den aktiven Bereich im Fenster ab.
Bereiche Ruft die Sammlung der Bereiche im Fenster ab.
WindowCollection getFirst() Ruft das erste Fenster in dieser Sammlung ab.
getFirstOrNullObject() Ruft das erste Fenster in dieser Sammlung ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

Siehe auch

  • Last updated on