Word.Shape class
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.
- Extends
[ API-Satz: WordApiDesktop 1.2 ]
| allow |
Gibt an, ob eine bestimmte Form andere Formen überlappen kann. |
| alt |
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 |
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| fill | Gibt die Füllformatierung der Form zurück. |
| geometric |
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. |
| height |
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. |
| is |
Ü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. |
| left |
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. |
| lock |
Gibt an, ob das Seitenverhältnis dieser Form gesperrt ist. |
| name | Der Name der Form. |
| parent |
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. |
| parent |
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. |
| relative |
Die relative horizontale Position der Form. Für eine Inlineform kann sie nicht festgelegt werden. Weitere Informationen finden Sie unter Word. RelativeHorizontalPosition. |
| relative |
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. |
| relative |
Die relative vertikale Position der Form. Für eine Inlineform kann sie nicht festgelegt werden. Weitere Informationen finden Sie unter Word. RelativeVerticalPosition. |
| relative |
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. |
| shape |
Ruft die shape-Gruppe ab, die der Form zugeordnet ist. Ein Objekt, dessen |
| text |
Ruft das Textrahmenobjekt der Form ab. |
| text |
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. |
| top |
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. |
| width |
Der Prozentsatz der Formbreite zur horizontalen relativen Größe, siehe Word. RelativeSize. Für eine Inline- oder untergeordnete Form kann sie nicht festgelegt werden. |
| delete() | Löscht die Form und ihren Inhalt. |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| move |
Verschiebt das Shape horizontal um die Anzahl der Punkte. |
| move |
Verschiebt die Form vertikal um die Anzahl der Punkte. |
| scale |
Skaliert die Höhe der Form anhand eines angegebenen Faktors. Für Bilder können Sie angeben, ob Sie die Form relativ zum Original oder zur aktuellen Größe skalieren möchten. Andere Formen als Bilder werden immer relativ zu ihrer aktuellen Höhe skaliert. |
| scale |
Skaliert die Höhe der Form anhand eines angegebenen Faktors. Für Bilder können Sie angeben, ob Sie die Form relativ zum Original oder zur aktuellen Größe skalieren möchten. Andere Formen als Bilder werden immer relativ zu ihrer aktuellen Höhe skaliert. |
| scale |
Skaliert die Breite der Form anhand eines angegebenen Faktors. Für Bilder können Sie angeben, ob Sie die Form relativ zum Original oder zur aktuellen Größe skalieren möchten. Andere Formen als Bilder werden immer relativ zu ihrer aktuellen Höhe skaliert. |
| scale |
Skaliert die Breite der Form anhand eines angegebenen Faktors. Für Bilder können Sie angeben, ob Sie die Form relativ zum Original oder zur aktuellen Größe skalieren möchten. Andere Formen als Bilder werden immer relativ zu ihrer aktuellen Höhe skaliert. |
| select(select |
Wählt die Form aus. |
| set(properties, options) | Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben. |
| set(properties) | Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt. |
| toJSON() | Überschreibt die JavaScript-Methode |
| track() | Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über |
| untrack() | Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen |
Gibt an, ob eine bestimmte Form andere Formen überlappen kann.
allowOverlap: boolean;Eigenschaftswert
boolean
Hinweise
Gibt eine Zeichenfolge an, die den alternativen Text darstellt, der der Form zugeordnet ist.
altTextDescription: string;Eigenschaftswert
string
Hinweise
Stellt das Body-Objekt der Form dar. Gilt nur für Textfelder und geometrische Formen.
readonly body: Word.Body;Eigenschaftswert
Hinweise
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.
readonly canvas: Word.Canvas;Eigenschaftswert
Hinweise
Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
Gibt die Füllformatierung der Form zurück.
readonly fill: Word.ShapeFill;Eigenschaftswert
Hinweise
Der geometrische Formtyp der Form. 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
Die Höhe der Form in Punkt.
height: number;Eigenschaftswert
number
Hinweise
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: number;Eigenschaftswert
number
Hinweise
Ruft eine ganze Zahl ab, die den Shape-Bezeichner darstellt.
readonly id: number;Eigenschaftswert
number
Hinweise
Überprüfen Sie, ob es sich bei diesem Shape um ein untergeordnetes Element einer Gruppenform oder einer Canvas-Form handelt.
readonly isChild: boolean;Eigenschaftswert
boolean
Hinweise
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: number;Eigenschaftswert
number
Hinweise
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: number;Eigenschaftswert
number
Hinweise
Gibt an, ob das Seitenverhältnis dieser Form gesperrt ist.
lockAspectRatio: boolean;Eigenschaftswert
boolean
Hinweise
Der Name der Form.
name: string;Eigenschaftswert
string
Hinweise
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.
readonly parentCanvas: Word.Shape;Eigenschaftswert
Hinweise
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.
readonly parentGroup: Word.Shape;Eigenschaftswert
Hinweise
Die relative horizontale Position der Form. 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
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: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";Eigenschaftswert
Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"
Hinweise
Die relative vertikale Position der Form. 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
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: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";Eigenschaftswert
Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"
Hinweise
Gibt die Drehung der Form in Grad an. Gilt nicht für Canvas-Shapes.
rotation: number;Eigenschaftswert
number
Hinweise
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.
readonly shapeGroup: Word.ShapeGroup;Eigenschaftswert
Hinweise
Ruft das Textrahmenobjekt der Form ab.
readonly textFrame: Word.TextFrame;Eigenschaftswert
Hinweise
Gibt die Textumbruchformatierung der Form zurück.
readonly textWrap: Word.ShapeTextWrap;Eigenschaftswert
Hinweise
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: number;Eigenschaftswert
number
Hinweise
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: number;Eigenschaftswert
number
Hinweise
Ruft den Formtyp ab. Derzeit werden nur die folgenden Formen unterstützt: Textfelder, geometrische Formen, Gruppen, Bilder und Canvass.
readonly type: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas";Eigenschaftswert
Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"
Hinweise
Gibt an, ob die Form sichtbar ist. Gilt nicht für Inline-Shapes.
visible: boolean;Eigenschaftswert
boolean
Hinweise
Die Breite der Form in Punkt.
width: number;Eigenschaftswert
number
Hinweise
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: number;Eigenschaftswert
number
Hinweise
Löscht die Form und ihren Inhalt.
delete(): void;Gibt zurück
void
Hinweise
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(options?: Word.Interfaces.ShapeLoadOptions): Word.Shape;Parameter
- options
- Word.Interfaces.ShapeLoadOptions
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
Gibt zurück
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames?: string | string[]): Word.Shape;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.Shape;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
Verschiebt das Shape horizontal um die Anzahl der Punkte.
moveHorizontally(distance: number): void;Parameter
- distance
-
number
Erforderlich. Gibt an, wie weit die Form horizontal verschoben werden soll (in Punkten). Verwenden Sie einen positiven Wert, um die Form nach rechts zu verschieben. Verwenden Sie einen negativen Wert, um die Form nach links zu verschieben.
Gibt zurück
void
Hinweise
Verschiebt die Form vertikal um die Anzahl der Punkte.
moveVertically(distance: number): void;Parameter
- distance
-
number
Erforderlich. Gibt an, wie weit die Form vertikal verschoben werden soll (in Punkten). Verwenden Sie einen positiven Wert, um die Form nach oben zu verschieben. Verwenden Sie einen negativen Wert, um die Form nach unten zu verschieben.
Gibt zurück
void
Hinweise
Skaliert die Höhe der Form anhand eines angegebenen Faktors. Für Bilder können Sie angeben, ob Sie die Form relativ zum Original oder zur aktuellen Größe skalieren möchten. Andere Formen als Bilder werden immer relativ zu ihrer aktuellen Höhe skaliert.
scaleHeight(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void;Parameter
- scaleFactor
-
number
Gibt das Verhältnis zwischen der Höhe der Form nach der Änderung ihrer Größe und der aktuellen oder ursprünglichen Höhe an.
- scaleType
- Word.ShapeScaleType
Gibt an, ob die Form relativ zur ursprünglichen oder aktuellen Größe skaliert wird. Die Ursprüngliche Größenskalierungsoption funktioniert nur für Bilder.
- scaleFrom
- Word.ShapeScaleFrom
Optional. Gibt an, welcher Teil der Form beim Skalieren die Position beibehält. Wenn sie nicht angegeben wird, stellt sie dar, dass die obere linke Ecke der Form ihre Position behält.
Gibt zurück
void
Hinweise
Skaliert die Höhe der Form anhand eines angegebenen Faktors. Für Bilder können Sie angeben, ob Sie die Form relativ zum Original oder zur aktuellen Größe skalieren möchten. Andere Formen als Bilder werden immer relativ zu ihrer aktuellen Höhe skaliert.
scaleHeight(scaleFactor: number, scaleTypeString: "CurrentSize" | "OriginalSize", scaleFromString?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void;Parameter
- scaleFactor
-
number
Gibt das Verhältnis zwischen der Höhe der Form nach der Änderung ihrer Größe und der aktuellen oder ursprünglichen Höhe an.
- scaleTypeString
-
"CurrentSize" | "OriginalSize"
Gibt an, ob die Form relativ zur ursprünglichen oder aktuellen Größe skaliert wird. Die Ursprüngliche Größenskalierungsoption funktioniert nur für Bilder.
- scaleFromString
-
"ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"
Optional. Gibt an, welcher Teil der Form beim Skalieren die Position beibehält. Wenn sie nicht angegeben wird, stellt sie dar, dass die obere linke Ecke der Form ihre Position behält.
Gibt zurück
void
Hinweise
Skaliert die Breite der Form anhand eines angegebenen Faktors. Für Bilder können Sie angeben, ob Sie die Form relativ zum Original oder zur aktuellen Größe skalieren möchten. Andere Formen als Bilder werden immer relativ zu ihrer aktuellen Höhe skaliert.
scaleWidth(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void;Parameter
- scaleFactor
-
number
Gibt das Verhältnis zwischen der Breite der Form nach der Änderung ihrer Größe und der aktuellen oder ursprünglichen Breite an.
- scaleType
- Word.ShapeScaleType
Gibt an, ob die Form relativ zur ursprünglichen oder aktuellen Größe skaliert wird. Die Ursprüngliche Größenskalierungsoption funktioniert nur für Bilder.
- scaleFrom
- Word.ShapeScaleFrom
Optional. Gibt an, welcher Teil der Form beim Skalieren die Position beibehält. Wenn sie nicht angegeben wird, stellt sie dar, dass die obere linke Ecke der Form ihre Position behält.
Gibt zurück
void
Hinweise
Skaliert die Breite der Form anhand eines angegebenen Faktors. Für Bilder können Sie angeben, ob Sie die Form relativ zum Original oder zur aktuellen Größe skalieren möchten. Andere Formen als Bilder werden immer relativ zu ihrer aktuellen Höhe skaliert.
scaleWidth(scaleFactor: number, scaleTypeString: "CurrentSize" | "OriginalSize", scaleFromString?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void;Parameter
- scaleFactor
-
number
Gibt das Verhältnis zwischen der Breite der Form nach der Änderung ihrer Größe und der aktuellen oder ursprünglichen Breite an.
- scaleTypeString
-
"CurrentSize" | "OriginalSize"
Gibt an, ob die Form relativ zur ursprünglichen oder aktuellen Größe skaliert wird. Die Ursprüngliche Größenskalierungsoption funktioniert nur für Bilder.
- scaleFromString
-
"ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"
Optional. Gibt an, welcher Teil der Form beim Skalieren die Position beibehält. Wenn sie nicht angegeben wird, stellt sie dar, dass die obere linke Ecke der Form ihre Position behält.
Gibt zurück
void
Hinweise
Wählt die Form aus.
select(selectMultipleShapes?: boolean): void;Parameter
- selectMultipleShapes
-
boolean
Optional. Gibt an, ob mehrere unverankerte Shapes ausgewählt werden sollen. Der Standardwert ist false.
Gibt zurück
void
Hinweise
Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Word.Interfaces.ShapeUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: Word.Shape): void;Parameter
- properties
- Word.Shape
Gibt zurück
void
Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Word.Shape Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.ShapeData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Word.Interfaces.ShapeData;Gibt zurück
Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.
track(): Word.Shape;Gibt zurück
Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.
untrack(): Word.Shape;Gibt zurück
Feedback zu Office Add-ins
Office Add-ins ist ein Open Source-Projekt. Wählen Sie einen Link aus, um Feedback zu geben: