Word.Interfaces.ShapeData interface

参考

包:: word

一个接口，用于描述通过调用 shape.toJSON()返回的数据。

属性

allowOverlap	指定给定的形状是否可以与其他形状重叠。
altTextDescription	指定表示与形状关联的可选文本的字符串。
body	表示形状的正文对象。仅适用于文本框和几何形状。
canvas	获取与形状关联的画布。如果形状类型不是“Canvas”，则会返回属性 `isNullObject` 设置为 `true` 的对象。有关详细信息，请参阅 *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	指定形状的旋转（以度为单位）。不适用于画布形状。
shapeGroup	获取与形状关联的形状组。如果形状类型不是“GroupShape”，则会返回属性 `isNullObject` 设置为 `true` 的对象。有关详细信息，请参阅 *OrNullObject 方法和属性。
textFrame	获取形状的文本框架对象。
textWrap	返回形状的文本换行格式。
top	从形状的上边缘到垂直相对位置的距离（以磅为单位），请参阅Word。RelativeVerticalPosition。对于内联形状，它将返回 0，无法设置。对于画布或组中的子形状，它相对于左上角。
topRelative	相对顶部位置（从形状的上边缘到垂直相对位置的百分比），请参阅 Word。RelativeVerticalPosition。对于内联形状或子形状，它将返回 0，并且无法设置。
type	获取形状类型。目前，仅支持以下形状：文本框、几何形状、组、图片和画布。
visible	指定形状是否可见。不适用于内联形状。
width	形状的宽度（以磅为单位）。
widthRelative	形状宽度与水平相对大小的百分比，请参阅 Word。RelativeSize。对于内联形状或子形状，无法设置它。

属性详细信息

allowOverlap

指定给定的形状是否可以与其他形状重叠。

allowOverlap?: boolean;

属性值

boolean

注解

[ API 集：WordApiDesktop 1.2 ]

altTextDescription

指定表示与形状关联的可选文本的字符串。

altTextDescription?: string;

属性值

string

注解

[ API 集：WordApiDesktop 1.2 ]

body

表示形状的正文对象。仅适用于文本框和几何形状。

body?: Word.Interfaces.BodyData;

属性值

Word.Interfaces.BodyData

注解

[ API 集：WordApiDesktop 1.2 ]

canvas

获取与形状关联的画布。如果形状类型不是“Canvas”，则会返回属性 isNullObject 设置为 true 的对象。有关详细信息，请参阅 *OrNullObject 方法和属性。

canvas?: Word.Interfaces.CanvasData;

属性值

Word.Interfaces.CanvasData

注解

[ API 集：WordApiDesktop 1.2 ]

fill

返回形状的填充格式。

fill?: Word.Interfaces.ShapeFillData;

属性值

Word.Interfaces.ShapeFillData

注解

[ API 集：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 集：WordApiDesktop 1.2 ]

height

形状的高度（以磅为单位）。

height?: number;

属性值

number

注解

[ API 集：WordApiDesktop 1.2 ]

heightRelative

形状高度与垂直相对大小的百分比，请参阅 Word。RelativeSize。对于内联形状或子形状，无法设置它。

heightRelative?: number;

属性值

number

注解

[ API 集：WordApiDesktop 1.2 ]

id

获取表示形状标识符的整数。

id?: number;

属性值

number

注解

[ API 集：WordApiDesktop 1.2 ]

isChild

检查此形状是组形状还是画布形状的子形状。

isChild?: boolean;

属性值

boolean

注解

[ API 集：WordApiDesktop 1.2 ]

left

从形状左侧到水平相对位置的距离（以磅为单位），请参阅Word。RelativeHorizontalPosition。对于内联形状，它将返回 0，无法设置。对于画布或组中的子形状，它相对于左上角。

left?: number;

属性值

number

注解

[ API 集：WordApiDesktop 1.2 ]

leftRelative

相对左侧位置（从形状左侧到水平相对位置的百分比），请参阅 Word。RelativeHorizontalPosition。对于内联形状或子形状，它将返回 0，并且无法设置。

leftRelative?: number;

属性值

number

注解

[ API 集：WordApiDesktop 1.2 ]

lockAspectRatio

指定是否锁定此形状的纵横比。

lockAspectRatio?: boolean;

属性值

boolean

注解

[ API 集：WordApiDesktop 1.2 ]

name

形状的名称。

name?: string;

属性值

string

注解

[ API 集：WordApiDesktop 1.2 ]

parentCanvas

获取此子形状的顶级父画布形状。如果不是画布的子形状，则它将为 null。

parentCanvas?: Word.Interfaces.ShapeData;

属性值

Word.Interfaces.ShapeData

注解

[ API 集：WordApiDesktop 1.2 ]

parentGroup

获取此子形状的顶级父组形状。如果不是组的子形状，则它将为 null。

parentGroup?: Word.Interfaces.ShapeData;

属性值

Word.Interfaces.ShapeData

注解

[ API 集：WordApiDesktop 1.2 ]

relativeHorizontalPosition

形状的相对水平位置。对于内联形状，无法设置它。有关详细信息，请参阅 Word。RelativeHorizontalPosition。

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

属性值

注解

[ API 集：WordApiDesktop 1.2 ]

relativeHorizontalSize

形状的相对水平大小。对于内联形状或子形状，无法设置它。有关详细信息，请参阅 Word。RelativeHorizontalPosition。

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

属性值

注解

[ API 集：WordApiDesktop 1.2 ]

relativeVerticalPosition

形状的相对垂直位置。对于内联形状，无法设置它。有关详细信息，请参阅 Word。RelativeVerticalPosition。

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

属性值

注解

[ API 集：WordApiDesktop 1.2 ]

relativeVerticalSize

形状的相对垂直大小。对于内联形状或子形状，无法设置它。有关详细信息，请参阅 Word。RelativeHorizontalPosition。

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

属性值

注解

[ API 集：WordApiDesktop 1.2 ]

rotation

指定形状的旋转（以度为单位）。不适用于画布形状。

rotation?: number;

属性值

number

注解

[ API 集：WordApiDesktop 1.2 ]

shapeGroup

获取与形状关联的形状组。如果形状类型不是“GroupShape”，则会返回属性 isNullObject 设置为 true 的对象。有关详细信息，请参阅 *OrNullObject 方法和属性。

shapeGroup?: Word.Interfaces.ShapeGroupData;

属性值

Word.Interfaces.ShapeGroupData

注解

[ API 集：WordApiDesktop 1.2 ]

textFrame

获取形状的文本框架对象。

textFrame?: Word.Interfaces.TextFrameData;

属性值

Word.Interfaces.TextFrameData

注解

[ API 集：WordApiDesktop 1.2 ]

textWrap

返回形状的文本换行格式。

textWrap?: Word.Interfaces.ShapeTextWrapData;

属性值

Word.Interfaces.ShapeTextWrapData

注解

[ API 集：WordApiDesktop 1.2 ]

top

从形状的上边缘到垂直相对位置的距离（以磅为单位），请参阅Word。RelativeVerticalPosition。对于内联形状，它将返回 0，无法设置。对于画布或组中的子形状，它相对于左上角。

top?: number;

属性值

number

注解

[ API 集：WordApiDesktop 1.2 ]

topRelative

相对顶部位置（从形状的上边缘到垂直相对位置的百分比），请参阅 Word。RelativeVerticalPosition。对于内联形状或子形状，它将返回 0，并且无法设置。

topRelative?: number;

属性值

number

注解

[ API 集：WordApiDesktop 1.2 ]

type

获取形状类型。目前，仅支持以下形状：文本框、几何形状、组、图片和画布。

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

属性值

注解

[ API 集：WordApiDesktop 1.2 ]

visible

指定形状是否可见。不适用于内联形状。

visible?: boolean;

属性值

boolean

注解

[ API 集：WordApiDesktop 1.2 ]

width

形状的宽度（以磅为单位）。

width?: number;

属性值

number

注解

[ API 集：WordApiDesktop 1.2 ]

widthRelative

形状宽度与水平相对大小的百分比，请参阅 Word。RelativeSize。对于内联形状或子形状，无法设置它。

widthRelative?: number;

属性值

number

注解

[ API 集：WordApiDesktop 1.2 ]