Word.Interfaces.ShapeLoadOptions interface

Paket:

word

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Stellt eine Form in der Kopf-, Fußzeile oder im Dokumenttext dar. Derzeit werden nur die folgenden Formen unterstützt: Textfelder, geometrisch, gruppiert und Bild.

Hinweise

[ API-Satz: WordApi BETA (NUR VORSCHAU) ]

Eigenschaften

$all	Wenn Sie $all für die Ladeoptionen angeben, werden alle skalaren Eigenschaften (zRange.address. B. ) geladen, aber nicht die Navigationseigenschaften (zRange.format.fill.color. B. ).
body	Stellt das Body-Objekt der Form dar. Gilt nur für Textfelder und geometrische Formen.
geometricShapeType	Der geometrische Formtyp der Form. Es ist NULL, wenn es sich nicht um eine geometrische Form handelt.
height	Die Höhe der Form in Punkt.
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	Der Abstand (in Punkt) von der linken Seite der Form zur horizontalen relativen Position finden Sie unter Word. RelativeHorizontalPosition. Bei einer Inlineform wird 0 zurückgegeben und kann nicht festgelegt werden.
name	Der Name der Form.
parentGroup	Ruft die übergeordnete Gruppenform der obersten Ebene dieser untergeordneten Form ab. Es ist NULL, wenn es sich nicht um eine untergeordnete Form handelt.
relativeHorizontalPosition	Die relative horizontale Position der Form. Für eine Inlineform kann sie nicht festgelegt werden. Weitere Informationen finden Sie unter Word. RelativeHorizontalPosition.
relativeVerticalPosition	Die relative vertikale Position der Form. Für eine Inlineform kann sie nicht festgelegt werden. Weitere Informationen finden Sie unter Word. RelativeVerticalPosition.
shapeGroup	Ruft die shape-Gruppe ab, die der Form zugeordnet ist. Ein Objekt, dessen isNullObject -Eigenschaft auf true festgelegt ist, wird zurückgegeben, wenn der Formtyp nicht "GroupShape" lautet. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
top	Der Abstand (in Punkt) vom oberen Rand der Form zur vertikalen relativen Position finden Sie unter Word. RelativeVerticalPosition. Bei einer Inlineform wird 0 zurückgegeben und kann nicht festgelegt werden.
type	Ruft den Formtyp ab. Derzeit werden nur die folgenden Formen unterstützt: Textfelder, geometrisch, gruppiert und Bild.
width	Die Breite der Form in Punkt.

Details zur Eigenschaft

$all

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Wenn Sie $all für die Ladeoptionen angeben, werden alle skalaren Eigenschaften (zRange.address. B. ) geladen, aber nicht die Navigationseigenschaften (zRange.format.fill.color. B. ).

$all?: boolean;

Eigenschaftswert

boolean

body

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Stellt das Body-Objekt der Form dar. Gilt nur für Textfelder und geometrische Formen.

body?: Word.Interfaces.BodyLoadOptions;

Eigenschaftswert

Word.Interfaces.BodyLoadOptions

Hinweise

[ API-Satz: WordApi BETA (NUR VORSCHAU) ]

geometricShapeType

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Der geometrische Formtyp der Form. Es ist NULL, wenn es sich nicht um eine geometrische Form handelt.

geometricShapeType?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi BETA (NUR VORSCHAU) ]

height

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Die Höhe der Form in Punkt.

height?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi BETA (NUR VORSCHAU) ]

id

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft eine ganze Zahl ab, die den Shape-Bezeichner darstellt.

id?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi BETA (NUR VORSCHAU) ]

isChild

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Überprüfen Sie, ob es sich bei diesem Shape um ein untergeordnetes Element einer Gruppenform oder einer Canvas-Form handelt.

isChild?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi BETA (NUR VORSCHAU) ]

left

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Der Abstand (in Punkt) von der linken Seite der Form zur horizontalen relativen Position finden Sie unter Word. RelativeHorizontalPosition. Bei einer Inlineform wird 0 zurückgegeben und kann nicht festgelegt werden.

left?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi BETA (NUR VORSCHAU) ]

name

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Der Name der Form.

name?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi BETA (NUR VORSCHAU) ]

parentGroup

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die übergeordnete Gruppenform der obersten Ebene dieser untergeordneten Form ab. Es ist NULL, wenn es sich nicht um eine untergeordnete Form handelt.

parentGroup?: Word.Interfaces.ShapeLoadOptions;

Eigenschaftswert

Word.Interfaces.ShapeLoadOptions

Hinweise

[ API-Satz: WordApi BETA (NUR VORSCHAU) ]

relativeHorizontalPosition

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Die relative horizontale Position der Form. Für eine Inlineform kann sie nicht festgelegt werden. Weitere Informationen finden Sie unter Word. RelativeHorizontalPosition.

relativeHorizontalPosition?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi BETA (NUR VORSCHAU) ]

relativeVerticalPosition

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Die relative vertikale Position der Form. Für eine Inlineform kann sie nicht festgelegt werden. Weitere Informationen finden Sie unter Word. RelativeVerticalPosition.

relativeVerticalPosition?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi BETA (NUR VORSCHAU) ]

shapeGroup

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die shape-Gruppe ab, die der Form zugeordnet ist. Ein Objekt, dessen isNullObject -Eigenschaft auf true festgelegt ist, wird zurückgegeben, wenn der Formtyp nicht "GroupShape" lautet. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions;

Eigenschaftswert

Word.Interfaces.ShapeGroupLoadOptions

Hinweise

[ API-Satz: WordApi BETA (NUR VORSCHAU) ]

top

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Der Abstand (in Punkt) vom oberen Rand der Form zur vertikalen relativen Position finden Sie unter Word. RelativeVerticalPosition. Bei einer Inlineform wird 0 zurückgegeben und kann nicht festgelegt werden.

top?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi BETA (NUR VORSCHAU) ]

type

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft den Formtyp ab. Derzeit werden nur die folgenden Formen unterstützt: Textfelder, geometrisch, gruppiert und Bild.

type?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi BETA (NUR VORSCHAU) ]

width

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Die Breite der Form in Punkt.

width?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi BETA (NUR VORSCHAU) ]