Word.Interfaces.ShapeData interface
Eine Schnittstelle, die die durch Aufrufen shape.toJSON()zurückgegebenen Daten beschreibt.
Eigenschaften
| allow |
Gibt an, ob ein bestimmtes Shape andere Shapes überlappen kann. |
| alt |
Gibt eine Zeichenfolge an, die den alternativen Text darstellt, der dem Shape zugeordnet ist. |
| body | Ruft das |
| canvas | Ruft den mit der Form verknüpften Zeichenbereich ab. Ein Objekt, dessen |
| fill | Gibt die Füllformatierung der Form zurück. |
| geometric |
Gibt den geometrischen Formtyp der Form an. Es ist null, wenn es sich nicht um eine geometrische Form handelt. |
| height | Gibt die Höhe des Shapes in Punkten an. |
| height |
Gibt den prozentualen Anteil der Formhöhe an der relativen vertikalen Größe (d. h. die |
| id | Ruft eine Ganzzahl ab, die den Formbezeichner darstellt. |
| is |
Ü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 |
| left |
Gibt die relative linke Position als Prozentwert von der linken Seite der Form zur relativen horizontalen Position (d. h. die |
| lock |
Gibt an, ob das Seitenverhältnis dieses Shapes gesperrt ist. |
| name | Gibt den Namen der Form an. |
| parent |
Ruft die übergeordnete Canvas-Form der obersten Ebene dieser untergeordneten Form ab. Er ist null, wenn es sich nicht um eine untergeordnete Form eines Zeichenbereichs handelt. |
| parent |
Ruft das Shape der übergeordneten Gruppe der obersten Ebene dieses untergeordneten Shapes ab. Er ist null, wenn es sich nicht um ein untergeordnetes Shape einer Gruppe handelt. |
| relative |
Gibt die relative horizontale Position der Form an. Für eine Inlineform kann sie nicht festgelegt werden. Weitere Informationen finden Sie unter Word. RelativeHorizontalPosition. |
| relative |
Gibt die relative horizontale Größe des Shapes an. Mit der |
| relative |
Gibt die relative vertikale Position der Form an. Für eine Inlineform kann sie nicht festgelegt werden. Weitere Informationen finden Sie unter Word. RelativeVerticalPosition. |
| relative |
Gibt die relative vertikale Größe der Form an. Mit der |
| rotation | Gibt die Drehung der Form in Grad an. Dies gilt nicht für Canvas-Shapes. |
| shape |
Ruft die mit dem Shape verknüpfte Formgruppe ab. Ein Objekt, dessen |
| text |
Ruft das |
| text |
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 |
| top |
Gibt die relative obere Position als Prozentsatz vom oberen Rand der Form bis zur relativen vertikalen Position (d. h. die |
| type | Ruft den Formtyp ab. Derzeit werden nur die folgenden Formen unterstützt: Textfelder, geometrische Formen, Gruppen, Bilder und Leinwände. |
| visible | Gibt an, ob das Shape sichtbar ist. Dies gilt nicht für Inlineformen. |
| width | Gibt die Breite des Shapes in Punkten an. |
| width |
Gibt den prozentualen Anteil der Formbreite an der relativen horizontalen Größe (d. h. die |
Details zur Eigenschaft
allowOverlap
Gibt an, ob ein bestimmtes Shape andere Shapes überlappen kann.
allowOverlap?: boolean;
Eigenschaftswert
boolean
Hinweise
altTextDescription
Gibt eine Zeichenfolge an, die den alternativen Text darstellt, der dem Shape zugeordnet ist.
altTextDescription?: string;
Eigenschaftswert
string
Hinweise
body
Ruft das Body Objekt der Form ab. Gilt nur für Textfelder und geometrische Formen.
body?: Word.Interfaces.BodyData;
Eigenschaftswert
Hinweise
canvas
Ruft den mit der Form verknüpften Zeichenbereich ab. Ein Objekt, dessen isNullObject Eigenschaft auf festgelegt ist, true wird zurückgegeben, wenn der Formtyp nicht canvasist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
canvas?: Word.Interfaces.CanvasData;
Eigenschaftswert
Hinweise
fill
Gibt die Füllformatierung der Form zurück.
fill?: Word.Interfaces.ShapeFillData;
Eigenschaftswert
Hinweise
geometricShapeType
Gibt den geometrischen Formtyp der Form an. Es ist null, wenn es sich nicht um eine geometrische Form handelt.
geometricShapeType?: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
Eigenschaftswert
Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"
Hinweise
height
Gibt die Höhe des Shapes in Punkten an.
height?: number;
Eigenschaftswert
number
Hinweise
heightRelative
Gibt den prozentualen Anteil der Formhöhe an der relativen vertikalen Größe (d. h. die relativeVerticalSize Eigenschaft) an. Für eine Inline- oder untergeordnete Form kann sie nicht festgelegt werden.
heightRelative?: number;
Eigenschaftswert
number
Hinweise
id
Ruft eine Ganzzahl ab, die den Formbezeichner darstellt.
id?: number;
Eigenschaftswert
number
Hinweise
isChild
Überprüfen Sie, ob dieses Shape einem Gruppen-Shape oder einem Canvas-Shape untergeordnet ist.
isChild?: boolean;
Eigenschaftswert
boolean
Hinweise
left
Gibt den Abstand in Punkten von der linken Seite der Form zur relativen horizontalen Position (d. h. der relativeHorizontalPosition Eigenschaft) an. Bei einer Inlineform gibt sie 0 zurück und kann nicht festgelegt werden. Bei einem untergeordneten Shape in einem Zeichenbereich oder einer Gruppe ist es relativ zur oberen linken Ecke.
left?: number;
Eigenschaftswert
number
Hinweise
leftRelative
Gibt die relative linke Position als Prozentwert von der linken Seite der Form zur relativen horizontalen Position (d. h. die relativeHorizontalalPosition Eigenschaft) an. Für eine Inline- oder untergeordnete Form gibt sie 0 zurück und kann nicht festgelegt werden.
leftRelative?: number;
Eigenschaftswert
number
Hinweise
lockAspectRatio
Gibt an, ob das Seitenverhältnis dieses Shapes gesperrt ist.
lockAspectRatio?: boolean;
Eigenschaftswert
boolean
Hinweise
name
Gibt den Namen der Form an.
name?: string;
Eigenschaftswert
string
Hinweise
parentCanvas
Ruft die übergeordnete Canvas-Form der obersten Ebene dieser untergeordneten Form ab. Er ist null, wenn es sich nicht um eine untergeordnete Form eines Zeichenbereichs handelt.
parentCanvas?: Word.Interfaces.ShapeData;
Eigenschaftswert
Hinweise
parentGroup
Ruft das Shape der übergeordneten Gruppe der obersten Ebene dieses untergeordneten Shapes ab. Er ist null, wenn es sich nicht um ein untergeordnetes Shape einer Gruppe handelt.
parentGroup?: Word.Interfaces.ShapeData;
Eigenschaftswert
Hinweise
relativeHorizontalPosition
Gibt die relative horizontale Position der Form an. Für eine Inlineform kann sie nicht festgelegt werden. Weitere Informationen finden Sie unter Word. RelativeHorizontalPosition.
relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
Eigenschaftswert
Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"
Hinweise
relativeHorizontalSize
Gibt die relative horizontale Größe des Shapes an. Mit der widthRelative Eigenschaft verwenden. Für eine Inline- oder untergeordnete Form kann sie nicht festgelegt werden.
relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
Eigenschaftswert
Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"
Hinweise
relativeVerticalPosition
Gibt die relative vertikale Position der Form an. Für eine Inlineform kann sie nicht festgelegt werden. Weitere Informationen finden Sie unter Word. RelativeVerticalPosition.
relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
Eigenschaftswert
Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"
Hinweise
relativeVerticalSize
Gibt die relative vertikale Größe der Form an. Mit der heightRelative Eigenschaft verwenden. Für eine Inline- oder untergeordnete Form kann sie nicht festgelegt werden.
relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
Eigenschaftswert
Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"
Hinweise
rotation
Gibt die Drehung der Form in Grad an. Dies gilt nicht für Canvas-Shapes.
rotation?: number;
Eigenschaftswert
number
Hinweise
shapeGroup
Ruft die mit dem Shape verknüpfte Formgruppe ab. Ein Objekt, dessen isNullObject Eigenschaft auf festgelegt ist, true wird zurückgegeben, wenn der Formtyp nicht groupShapeist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
shapeGroup?: Word.Interfaces.ShapeGroupData;
Eigenschaftswert
Hinweise
textFrame
Ruft das TextFrame Objekt der Form ab.
textFrame?: Word.Interfaces.TextFrameData;
Eigenschaftswert
Hinweise
textWrap
Gibt die Textumbruchformatierung der Form zurück.
textWrap?: Word.Interfaces.ShapeTextWrapData;
Eigenschaftswert
Hinweise
top
Gibt den Abstand in Punkten vom oberen Rand der Form zur relativen vertikalen Position (d. h. der relativeVerticalPosition Eigenschaft) an. Bei einer Inlineform gibt sie 0 zurück und kann nicht festgelegt werden. Bei einem untergeordneten Shape in einem Zeichenbereich oder einer Gruppe ist es relativ zur oberen linken Ecke.
top?: number;
Eigenschaftswert
number
Hinweise
topRelative
Gibt die relative obere Position als Prozentsatz vom oberen Rand der Form bis zur relativen vertikalen Position (d. h. die relativeVerticalPosition Eigenschaft) an. Für eine Inline- oder untergeordnete Form gibt sie 0 zurück und kann nicht festgelegt werden.
topRelative?: number;
Eigenschaftswert
number
Hinweise
type
Ruft den Formtyp ab. Derzeit werden nur die folgenden Formen unterstützt: Textfelder, geometrische Formen, Gruppen, Bilder und Leinwände.
type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas";
Eigenschaftswert
Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"
Hinweise
visible
Gibt an, ob das Shape sichtbar ist. Dies gilt nicht für Inlineformen.
visible?: boolean;
Eigenschaftswert
boolean
Hinweise
width
Gibt die Breite des Shapes in Punkten an.
width?: number;
Eigenschaftswert
number
Hinweise
widthRelative
Gibt den prozentualen Anteil der Formbreite an der relativen horizontalen Größe (d. h. die relativeHorizontalSize Eigenschaft) an. Für eine Inline- oder untergeordnete Form kann sie nicht festgelegt werden.
widthRelative?: number;
Eigenschaftswert
number