Freigeben über

Word Anforderungssatz 1.2 der JavaScript-API für Desktops

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 freigegebenen Anforderungssatz (WordApi 1.[NEXT]) hinzugefügt. Sobald dieser neue Anforderungssatz öffentlich ist, werden diese APIs auch weiterhin in diesem Anforderungssatz WordApiDesktop markiert. Weitere Informationen zu plattformspezifischen Anforderungen im Allgemeinen finden Sie unter Grundlegendes zu plattformspezifischen Anforderungssätzen.

Wichtig

WordApiDesktop 1.2 ist ein Nur-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 ü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.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. 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.2 . 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.2 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 Auflistung von Shape -Objekten im Text ab, einschließlich Inline- und unverankerten Formen.
Leinwand id Ruft eine ganze Zahl ab, die den Canvas-Bezeichner darstellt.
shape Ruft das Shape -Objekt ab, das der Canvas zugeordnet ist.
shapes Ruft die Auflistung von Word ab. Shape-Objekte.
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 an, ob die Schriftart als ausgeblendet gekennzeichnet ist.
InsertShapeOptions height Wenn angegeben, gibt die Höhe der einzufügenden Form an.
left Wenn angegeben, gibt die linke Position der einzufügenden Form an.
top Wenn angegeben, gibt die oberste Position der einzufügenden Form an.
width Wenn angegeben, gibt 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- 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.
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.
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 Shape objekte ab, die im Absatz verankert sind, einschließlich inline- und unverankerter Formen.
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 von Shape Objekten ab, die im Bereich verankert sind, einschließlich inline- und unverankerter Formen.
Shape allowOverlap Gibt an, ob eine bestimmte Form andere Formen überlappen kann.
altTextDescription Gibt eine Zeichenfolge an, die den alternativen Text darstellt, der der Form zugeordnet ist.
Text Ruft das Body -Objekt der Form ab.
Leinwand Ruft den Canvas ab, der der Form zugeordnet ist.
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 der Form in Punkt an.
heightRelative Gibt den Prozentsatz der Shape-Höhe an der relativen vertikalen Größe (d. a. der -Eigenschaft) an relativeVerticalSize .
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 Gibt den Abstand in Punkt von der linken Seite der Form zur relativen horizontalen Position (d. a. der -Eigenschaft) an relativeHorizontalPosition .
leftRelative Gibt die relative linke Position als Prozentsatz von der linken Seite der Form bis zur relativen horizontalen Position (d. a. die -Eigenschaft) an relativeHorizontalalPosition .
lockAspectRatio Gibt an, ob das Seitenverhältnis dieser Form gesperrt ist.
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 Gibt den Namen der Form an.
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 Gibt die relative horizontale Position der Form an.
relativeHorizontalSize Gibt die relative horizontale Größe der Form 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?: boolean) Wählt die Form aus.
shapeGroup Ruft die shape-Gruppe ab, die der Form zugeordnet ist.
textFrame Ruft das TextFrame -Objekt der Form ab.
textWrap Gibt die Textumbruchformatierung der Form zurück.
top Gibt den Abstand in Punkt vom oberen Rand der Form bis zur relativen vertikalen Position (d. a. der -Eigenschaft) an relativeVerticalPosition .
topRelative Gibt die relative obere Position als Prozentsatz vom oberen Rand der Form bis zur relativen vertikalen Position (d. a. die -Eigenschaft) an relativeVerticalPosition .
type Ruft den Formtyp ab.
visible Gibt an, ob die Form sichtbar ist.
width Gibt die Breite der Form in Punkt an.
widthRelative Gibt den Prozentsatz der Shape-Breite an der relativen horizontalen Größe (d. a. der -Eigenschaft) an relativeHorizontalSize .
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 fest Word.ShapeFillType.noFill.
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 der Gruppe zugeordnete -Objekt ab.
shapes Ruft die Auflistung von -Objekten ab Shape .
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 der angegebenen Form umgebrochen werden soll, nur auf der linken oder rechten Seite oder auf der Seite der Form, 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 Einstellungen für die automatische Größenanpassung für den Textrahmen an.
bottomMargin Gibt den unteren Rand des Textrahmens in Punkt an.
hasText Gibt zurück true , wenn der Textrahmen Text enthält, falseandernfalls .
leftMargin Gibt den linken Rand des Textrahmens in Punkt an.
noTextRotation Gibt an, ob der Text im Textrahmen nicht gedreht werden soll, wenn die Form gedreht wird.
orientation Gibt den Winkel an, an dem der Text für den Textrahmen ausgerichtet ist.
rightMargin Gibt den rechten Rand des Textrahmens in Punkt an.
topMargin Gibt den oberen Rand des Textrahmens in Punkt an.
verticalAlignment Gibt die vertikale Ausrichtung des Textrahmens an.
Wordwrap Bestimmt, ob Zeilen automatisch umbrechen, um Text in die Form einzupassen.
Window activePane Ruft den aktiven Bereich im Fenster ab.
Bereiche 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.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

Siehe auch

  • Last updated on