Word.Interfaces.ShapeLoadOptions interface

Paket:

word

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

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

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. ).
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.
body	Stellt das Body-Objekt der Form dar. Gilt nur für Textfelder und geometrische Formen.
canvas	Ruft den Canvas ab, der der Form zugeordnet ist. Ein Objekt, dessen isNullObject -Eigenschaft auf true festgelegt ist, wird zurückgegeben, wenn der Formtyp nicht "Canvas" lautet. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
fill	Gibt die Füllformatierung der Form zurück.
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.
heightRelative	Der Prozentsatz der Shape-Höhe zur vertikalen relativen Größe, siehe Word. RelativeSize. Für eine Inline- oder untergeordnete Form kann sie nicht festgelegt werden.
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. Bei einer untergeordneten Form in einer Canvas oder Gruppe ist sie relativ zur oberen linken Ecke.
leftRelative	Die relative linke Position als Prozentsatz von der linken Seite des Shapes zur horizontalen relativen Position, siehe Word. RelativeHorizontalPosition. Für eine Inline- oder untergeordnete Form gibt sie 0 zurück und kann nicht festgelegt werden.
lockAspectRatio	Gibt an, ob das Seitenverhältnis dieser Form gesperrt ist.
name	Der Name der Form.
parentCanvas	Ruft die übergeordnete Canvas-Form der obersten Ebene dieser untergeordneten Form ab. Es ist NULL, wenn es sich nicht um eine untergeordnete Form eines Zeichenbereichs handelt.
parentGroup	Ruft die übergeordnete Gruppenform der obersten Ebene dieser untergeordneten Form ab. Es ist NULL, wenn es sich nicht um eine untergeordnete Form einer Gruppe handelt.
relativeHorizontalPosition	Die relative horizontale Position der Form. Für eine Inlineform kann sie nicht festgelegt werden. Weitere Informationen finden Sie unter Word. RelativeHorizontalPosition.
relativeHorizontalSize	Die relative horizontale Größe der Form. Für eine Inline- oder untergeordnete Form 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.
relativeVerticalSize	Die relative vertikale Größe der Form. Für eine Inline- oder untergeordnete Form kann sie nicht festgelegt werden. Weitere Informationen finden Sie unter Word. RelativeHorizontalPosition.
rotation	Gibt die Drehung der Form in Grad an. Gilt nicht für Canvas-Shapes.
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.
textFrame	Ruft das Textrahmenobjekt der Form ab.
textWrap	Gibt die Textumbruchformatierung der Form zurück.
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. Bei einer untergeordneten Form in einer Canvas oder Gruppe ist sie relativ zur oberen linken Ecke.
topRelative	Die relative obere Position als Prozentsatz vom oberen Rand der Form bis zur vertikalen relativen Position, siehe Word. RelativeVerticalPosition. Für eine Inline- oder untergeordnete Form gibt sie 0 zurück und kann nicht festgelegt werden.
type	Ruft den Formtyp ab. Derzeit werden nur die folgenden Formen unterstützt: Textfelder, geometrische Formen, Gruppen, Bilder und Canvass.
visible	Gibt an, ob die Form sichtbar ist. Gilt nicht für Inline-Shapes.
width	Die Breite der Form in Punkt.
widthRelative	Der Prozentsatz der Formbreite zur horizontalen relativen Größe, siehe Word. RelativeSize. Für eine Inline- oder untergeordnete Form kann sie nicht festgelegt werden.

Details zur Eigenschaft

$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. ).

$all?: boolean;

Eigenschaftswert

boolean

allowOverlap

Gibt an, ob eine bestimmte Form andere Formen überlappen kann.

allowOverlap?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

altTextDescription

Gibt eine Zeichenfolge an, die den alternativen Text darstellt, der der Form zugeordnet ist.

altTextDescription?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

body

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: WordApiDesktop 1.2 ]

canvas

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

canvas?: Word.Interfaces.CanvasLoadOptions;

Eigenschaftswert

Word.Interfaces.CanvasLoadOptions

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

fill

Gibt die Füllformatierung der Form zurück.

fill?: Word.Interfaces.ShapeFillLoadOptions;

Eigenschaftswert

Word.Interfaces.ShapeFillLoadOptions

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

geometricShapeType

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

geometricShapeType?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

height

Die Höhe der Form in Punkt.

height?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

heightRelative

Der Prozentsatz der Shape-Höhe zur vertikalen relativen Größe, siehe Word. RelativeSize. Für eine Inline- oder untergeordnete Form kann sie nicht festgelegt werden.

heightRelative?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

id

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

id?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

isChild

Ü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: WordApiDesktop 1.2 ]

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. Bei einer untergeordneten Form in einer Canvas oder Gruppe ist sie relativ zur oberen linken Ecke.

left?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

leftRelative

Die relative linke Position als Prozentsatz von der linken Seite des Shapes zur horizontalen relativen Position, siehe Word. RelativeHorizontalPosition. Für eine Inline- oder untergeordnete Form gibt sie 0 zurück und kann nicht festgelegt werden.

leftRelative?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

lockAspectRatio

Gibt an, ob das Seitenverhältnis dieser Form gesperrt ist.

lockAspectRatio?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

name

Der Name der Form.

name?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

parentCanvas

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

parentCanvas?: Word.Interfaces.ShapeLoadOptions;

Eigenschaftswert

Word.Interfaces.ShapeLoadOptions

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

parentGroup

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

parentGroup?: Word.Interfaces.ShapeLoadOptions;

Eigenschaftswert

Word.Interfaces.ShapeLoadOptions

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

relativeHorizontalPosition

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: WordApiDesktop 1.2 ]

relativeHorizontalSize

Die relative horizontale Größe der Form. Für eine Inline- oder untergeordnete Form kann sie nicht festgelegt werden. Weitere Informationen finden Sie unter Word. RelativeHorizontalPosition.

relativeHorizontalSize?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

relativeVerticalPosition

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: WordApiDesktop 1.2 ]

relativeVerticalSize

Die relative vertikale Größe der Form. Für eine Inline- oder untergeordnete Form kann sie nicht festgelegt werden. Weitere Informationen finden Sie unter Word. RelativeHorizontalPosition.

relativeVerticalSize?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

rotation

Gibt die Drehung der Form in Grad an. Gilt nicht für Canvas-Shapes.

rotation?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

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.

shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions;

Eigenschaftswert

Word.Interfaces.ShapeGroupLoadOptions

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

textFrame

Ruft das Textrahmenobjekt der Form ab.

textFrame?: Word.Interfaces.TextFrameLoadOptions;

Eigenschaftswert

Word.Interfaces.TextFrameLoadOptions

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

textWrap

Gibt die Textumbruchformatierung der Form zurück.

textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions;

Eigenschaftswert

Word.Interfaces.ShapeTextWrapLoadOptions

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

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. Bei einer untergeordneten Form in einer Canvas oder Gruppe ist sie relativ zur oberen linken Ecke.

top?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

topRelative

Die relative obere Position als Prozentsatz vom oberen Rand der Form bis zur vertikalen relativen Position, siehe Word. RelativeVerticalPosition. Für eine Inline- oder untergeordnete Form gibt sie 0 zurück und kann nicht festgelegt werden.

topRelative?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

type

Ruft den Formtyp ab. Derzeit werden nur die folgenden Formen unterstützt: Textfelder, geometrische Formen, Gruppen, Bilder und Canvass.

type?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

visible

Gibt an, ob die Form sichtbar ist. Gilt nicht für Inline-Shapes.

visible?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

width

Die Breite der Form in Punkt.

width?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

widthRelative

Der Prozentsatz der Formbreite zur horizontalen relativen Größe, siehe Word. RelativeSize. Für eine Inline- oder untergeordnete Form kann sie nicht festgelegt werden.

widthRelative?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]