Word.Interfaces.ShapeData interface

リファレンス

パッケージ:: word

shape.toJSON() を呼び出すことによって返されるデータを記述するインターフェイス。

プロパティ

allowOverlap	特定の図形が他の図形と重なることができるかどうかを指定します。
altTextDescription	図形に関連付けられている代替テキストを表す文字列を指定します。
body	図形の body オブジェクトを表します。テキストボックスと幾何学的図形にのみ適用されます。
canvas	図形に関連付けられているキャンバスを取得します。 `isNullObject` プロパティが `true` に設定されているオブジェクトは、図形の種類が "Canvas" でない場合に返されます。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
fill	図形の塗りつぶしの書式設定を返します。
geometricShapeType	図形の幾何学的図形の種類。幾何学的図形でない場合は null になります。
height	図形の高さ (ポイント単位)。
heightRelative	垂直方向の相対的なサイズに対する図形の高さの割合については、「Word」を参照してください。RelativeSize。インライン図形または子図形の場合は、設定できません。
id	図形識別子を表す整数を取得します。
isChild	この図形がグループ図形またはキャンバス図形の子であるかどうかを確認します。
left	図形の左側から水平方向の相対位置までの距離 (ポイント単位) については、「Word」を参照してください。RelativeHorizontalPosition。インライン図形の場合、0 が返され、設定できません。キャンバスまたはグループ内の子図形の場合、左上隅を基準にしています。
leftRelative	図形の左側から水平方向の相対位置に対する割合としての相対左位置については、「Word」を参照してください。RelativeHorizontalPosition。インライン図形または子図形の場合、0 が返され、設定できません。
lockAspectRatio	この図形の縦横比がロックされているかどうかを指定します。
name	図形の名前。
parentCanvas	この子図形の最上位の親キャンバス図形を取得します。キャンバスの子図形でない場合は null になります。
parentGroup	この子図形の最上位の親グループ図形を取得します。グループの子図形でない場合は null になります。
relativeHorizontalPosition	図形の相対的な水平位置。インライン図形の場合は、設定できません。詳細については、「Word」を参照してください。RelativeHorizontalPosition。
relativeHorizontalSize	図形の相対的な水平サイズ。インライン図形または子図形の場合は、設定できません。詳細については、「Word」を参照してください。RelativeHorizontalPosition。
relativeVerticalPosition	図形の相対的な垂直位置。インライン図形の場合は、設定できません。詳細については、「Word」を参照してください。RelativeVerticalPosition。
relativeVerticalSize	図形の相対的な垂直サイズ。インライン図形または子図形の場合は、設定できません。詳細については、「Word」を参照してください。RelativeHorizontalPosition。
rotation	図形の回転を度単位で指定します。 Canvas 図形には適用されません。
shapeGroup	図形に関連付けられている図形グループを取得します。 `isNullObject` プロパティが `true` に設定されているオブジェクトは、図形の種類が "GroupShape" でない場合に返されます。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
textFrame	図形のテキストフレームオブジェクトを取得します。
textWrap	図形のテキスト折り返し書式を返します。
top	図形の上端から垂直方向の相対位置までの距離 (ポイント単位) については、「Word」を参照してください。RelativeVerticalPosition。インライン図形の場合、0 が返され、設定できません。キャンバスまたはグループ内の子図形の場合、左上隅を基準にしています。
topRelative	図形の上端から垂直方向の相対位置までのパーセンテージとしての相対的な上端の位置については、「Word」を参照してください。RelativeVerticalPosition。インライン図形または子図形の場合、0 が返され、設定できません。
type	図形の種類を取得します。現在、サポートされている図形は、テキストボックス、幾何学的図形、グループ、図、キャンバスのみです。
visible	図形を表示するかどうかを指定します。インライン図形には適用されません。
width	図形の幅をポイント単位で指定します。
widthRelative	水平方向の相対サイズに対する図形の幅の割合については、「Word」を参照してください。RelativeSize。インライン図形または子図形の場合は、設定できません。

プロパティの詳細

allowOverlap

特定の図形が他の図形と重なることができるかどうかを指定します。

allowOverlap?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

altTextDescription

図形に関連付けられている代替テキストを表す文字列を指定します。

altTextDescription?: string;

プロパティ値

string

注釈

[ API set: WordApiDesktop 1.2 ]

body

図形の body オブジェクトを表します。テキストボックスと幾何学的図形にのみ適用されます。

body?: Word.Interfaces.BodyData;

プロパティ値

Word.Interfaces.BodyData

注釈

[ API set: WordApiDesktop 1.2 ]

canvas

図形に関連付けられているキャンバスを取得します。 isNullObject プロパティが true に設定されているオブジェクトは、図形の種類が "Canvas" でない場合に返されます。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

canvas?: Word.Interfaces.CanvasData;

プロパティ値

Word.Interfaces.CanvasData

注釈

[ API set: WordApiDesktop 1.2 ]

fill

図形の塗りつぶしの書式設定を返します。

fill?: Word.Interfaces.ShapeFillData;

プロパティ値

Word.Interfaces.ShapeFillData

注釈

[ API set: WordApiDesktop 1.2 ]

geometricShapeType

図形の幾何学的図形の種類。幾何学的図形でない場合は null になります。

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";

プロパティ値

注釈

[ API set: WordApiDesktop 1.2 ]

height

図形の高さ (ポイント単位)。

height?: number;

プロパティ値

number

注釈

[ API set: WordApiDesktop 1.2 ]

heightRelative

垂直方向の相対的なサイズに対する図形の高さの割合については、「Word」を参照してください。RelativeSize。インライン図形または子図形の場合は、設定できません。

heightRelative?: number;

プロパティ値

number

注釈

[ API set: WordApiDesktop 1.2 ]

id

図形識別子を表す整数を取得します。

id?: number;

プロパティ値

number

注釈

[ API set: WordApiDesktop 1.2 ]

isChild

この図形がグループ図形またはキャンバス図形の子であるかどうかを確認します。

isChild?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

left

図形の左側から水平方向の相対位置までの距離 (ポイント単位) については、「Word」を参照してください。RelativeHorizontalPosition。インライン図形の場合、0 が返され、設定できません。キャンバスまたはグループ内の子図形の場合、左上隅を基準にしています。

left?: number;

プロパティ値

number

注釈

[ API set: WordApiDesktop 1.2 ]

leftRelative

図形の左側から水平方向の相対位置に対する割合としての相対左位置については、「Word」を参照してください。RelativeHorizontalPosition。インライン図形または子図形の場合、0 が返され、設定できません。

leftRelative?: number;

プロパティ値

number

注釈

[ API set: WordApiDesktop 1.2 ]

lockAspectRatio

この図形の縦横比がロックされているかどうかを指定します。

lockAspectRatio?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

name

図形の名前。

name?: string;

プロパティ値

string

注釈

[ API set: WordApiDesktop 1.2 ]

parentCanvas

この子図形の最上位の親キャンバス図形を取得します。キャンバスの子図形でない場合は null になります。

parentCanvas?: Word.Interfaces.ShapeData;

プロパティ値

Word.Interfaces.ShapeData

注釈

[ API set: WordApiDesktop 1.2 ]

parentGroup

この子図形の最上位の親グループ図形を取得します。グループの子図形でない場合は null になります。

parentGroup?: Word.Interfaces.ShapeData;

プロパティ値

Word.Interfaces.ShapeData

注釈

[ API set: WordApiDesktop 1.2 ]

relativeHorizontalPosition

図形の相対的な水平位置。インライン図形の場合は、設定できません。詳細については、「Word」を参照してください。RelativeHorizontalPosition。

relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";

プロパティ値

注釈

[ API set: WordApiDesktop 1.2 ]

relativeHorizontalSize

図形の相対的な水平サイズ。インライン図形または子図形の場合は、設定できません。詳細については、「Word」を参照してください。RelativeHorizontalPosition。

relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";

プロパティ値

注釈

[ API set: WordApiDesktop 1.2 ]

relativeVerticalPosition

図形の相対的な垂直位置。インライン図形の場合は、設定できません。詳細については、「Word」を参照してください。RelativeVerticalPosition。

relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";

プロパティ値

注釈

[ API set: WordApiDesktop 1.2 ]

relativeVerticalSize

図形の相対的な垂直サイズ。インライン図形または子図形の場合は、設定できません。詳細については、「Word」を参照してください。RelativeHorizontalPosition。

relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";

プロパティ値

注釈

[ API set: WordApiDesktop 1.2 ]

rotation

図形の回転を度単位で指定します。 Canvas 図形には適用されません。

rotation?: number;

プロパティ値

number

注釈

[ API set: WordApiDesktop 1.2 ]

shapeGroup

図形に関連付けられている図形グループを取得します。 isNullObject プロパティが true に設定されているオブジェクトは、図形の種類が "GroupShape" でない場合に返されます。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

shapeGroup?: Word.Interfaces.ShapeGroupData;

プロパティ値

Word.Interfaces.ShapeGroupData

注釈

[ API set: WordApiDesktop 1.2 ]

textFrame

図形のテキストフレームオブジェクトを取得します。

textFrame?: Word.Interfaces.TextFrameData;

プロパティ値

Word.Interfaces.TextFrameData

注釈

[ API set: WordApiDesktop 1.2 ]

textWrap

図形のテキスト折り返し書式を返します。

textWrap?: Word.Interfaces.ShapeTextWrapData;

プロパティ値

Word.Interfaces.ShapeTextWrapData

注釈

[ API set: WordApiDesktop 1.2 ]

top

図形の上端から垂直方向の相対位置までの距離 (ポイント単位) については、「Word」を参照してください。RelativeVerticalPosition。インライン図形の場合、0 が返され、設定できません。キャンバスまたはグループ内の子図形の場合、左上隅を基準にしています。

top?: number;

プロパティ値

number

注釈

[ API set: WordApiDesktop 1.2 ]

topRelative

図形の上端から垂直方向の相対位置までのパーセンテージとしての相対的な上端の位置については、「Word」を参照してください。RelativeVerticalPosition。インライン図形または子図形の場合、0 が返され、設定できません。

topRelative?: number;

プロパティ値

number

注釈

[ API set: WordApiDesktop 1.2 ]

type

図形の種類を取得します。現在、サポートされている図形は、テキストボックス、幾何学的図形、グループ、図、キャンバスのみです。

type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas";

プロパティ値

注釈

[ API set: WordApiDesktop 1.2 ]

visible

図形を表示するかどうかを指定します。インライン図形には適用されません。

visible?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

width

図形の幅をポイント単位で指定します。

width?: number;

プロパティ値

number

注釈

[ API set: WordApiDesktop 1.2 ]

widthRelative

水平方向の相対サイズに対する図形の幅の割合については、「Word」を参照してください。RelativeSize。インライン図形または子図形の場合は、設定できません。

widthRelative?: number;

プロパティ値

number

注釈

[ API set: WordApiDesktop 1.2 ]

次の方法で共有

Word.Interfaces.ShapeData interface

プロパティ

プロパティの詳細

allowOverlap

プロパティ値

注釈

altTextDescription

プロパティ値

注釈

body

プロパティ値

注釈

canvas

プロパティ値

注釈

fill

プロパティ値

注釈

geometricShapeType

プロパティ値

注釈

height

プロパティ値

注釈

heightRelative

プロパティ値

注釈

id

プロパティ値

注釈

isChild

プロパティ値

注釈

left

プロパティ値

注釈

leftRelative

プロパティ値

注釈

lockAspectRatio

プロパティ値

注釈

name

プロパティ値

注釈

parentCanvas

プロパティ値

注釈

parentGroup

プロパティ値

注釈

relativeHorizontalPosition

プロパティ値

注釈

relativeHorizontalSize

プロパティ値

注釈

relativeVerticalPosition

プロパティ値

注釈

relativeVerticalSize

プロパティ値

注釈

rotation

プロパティ値

注釈

shapeGroup

プロパティ値

注釈

textFrame

プロパティ値

注釈

textWrap

プロパティ値

注釈

top

プロパティ値

注釈

topRelative