Word.Shape class

参考

包:: word

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

表示页眉、页脚或文档正文中的形状。目前，仅支持以下形状：文本框、几何形状、分组形状和图片。

扩展: OfficeExtension.ClientObject

注解

[ API 集：WordApi BETA (仅预览版) ]

属性

body	表示形状的正文对象。仅适用于文本框和几何形状。
context	与对象关联的请求上下文。这会将加载项的进程连接到 Office 主机应用程序的进程。
geometricShapeType	形状的几何形状类型。如果不是几何形状，则它将为 null。
height	形状的高度（以磅为单位）。
id	获取表示形状标识符的整数。
left	从形状左侧到水平相对位置的距离（以磅为单位），请参阅Word。RelativeHorizontalPosition。对于内联形状，它将返回 0，无法设置。
name	形状的名称。
relativeHorizontalPosition	形状的相对水平位置。对于内联形状，无法设置它。有关详细信息，请参阅 Word。RelativeHorizontalPosition。
relativeVerticalPosition	形状的相对垂直位置。对于内联形状，无法设置它。有关详细信息，请参阅 Word。RelativeVerticalPosition。
shapeGroup	获取与形状关联的形状组。如果形状类型不是“GroupShape”，则会返回属性 `isNullObject` 设置为 `true` 的对象。有关详细信息，请参阅 *OrNullObject 方法和属性。
top	从形状的上边缘到垂直相对位置的距离（以磅为单位），请参阅Word。RelativeVerticalPosition。对于内联形状，它将返回 0，无法设置。
type	获取形状类型。目前，仅支持以下形状：文本框、几何形状、分组形状和图片。
width	形状的宽度（以磅为单位）。

方法

delete()	删除形状及其内容。
load(options)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNames)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
moveHorizontally(distance)	按磅数水平移动形状。
moveVertically(distance)	按磅数垂直移动形状。
select(selectMultipleShapes)	选择形状。
set(properties, options)	同时设置对象的多个属性。可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties)	基于现有的已加载对象，同时对对象设置多个属性。
toJSON()	重写 JavaScript `toJSON()` 方法，以便在将 API 对象传递给 `JSON.stringify()`时提供更有用的输出。 `JSON.stringify` (，依次调用`toJSON`传递给它的对象的方法。) 虽然原始`Word.Shape`对象是 API 对象，`toJSON`但该方法返回一个纯 JavaScript 对象， (类型为 `Word.Interfaces.ShapeData`) ，其中包含从原始对象加载的任何子属性的浅表副本。
track()	根据文档中的相应更改来跟踪对象，以便进行自动调整。此调用是 context.trackedObjects.add (thisObject) 的简写。如果跨 `.sync` 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。如果此对象是集合的一部分，则还应跟踪父集合。
untrack()	释放与此对象关联的内存（如果先前已跟踪过）。此调用是 context.trackedObjects.remove (thisObject) 的简写。拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。在内存发布生效之前，需要调用 `context.sync()` 。

属性详细信息

body

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

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

readonly body: Word.Body;

属性值

Word.Body

注解

[ API 集：WordApi BETA (仅预览版) ]

context

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

与对象关联的请求上下文。这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

Word.RequestContext

geometricShapeType

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

形状的几何形状类型。如果不是几何形状，则它将为 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 集：WordApi BETA (仅预览版) ]

height

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

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

height: number;

属性值

number

注解

[ API 集：WordApi BETA (仅预览版) ]

id

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

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

readonly id: number;

属性值

number

注解

[ API 集：WordApi BETA (仅预览版) ]

left

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

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

left: number;

属性值

number

注解

[ API 集：WordApi BETA (仅预览版) ]

name

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

形状的名称。

name: string;

属性值

string

注解

[ API 集：WordApi BETA (仅预览版) ]

relativeHorizontalPosition

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

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

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

属性值

注解

[ API 集：WordApi BETA (仅预览版) ]

relativeVerticalPosition

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

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

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

属性值

注解

[ API 集：WordApi BETA (仅预览版) ]

shapeGroup

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

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

readonly shapeGroup: Word.ShapeGroup;

属性值

Word.ShapeGroup

注解

[ API 集：WordApi BETA (仅预览版) ]

top

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

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

top: number;

属性值

number

注解

[ API 集：WordApi BETA (仅预览版) ]

type

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

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

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

属性值

注解

[ API 集：WordApi BETA (仅预览版) ]

width

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

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

width: number;

属性值

number

注解

[ API 集：WordApi BETA (仅预览版) ]

方法详细信息

delete()

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

删除形状及其内容。

delete(): void;

void

注解

[ API 集：WordApi BETA (仅预览版) ]

load(options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 context.sync()。

load(options?: Word.Interfaces.ShapeLoadOptions): Word.Shape;

参数

options: Word.Interfaces.ShapeLoadOptions

提供要加载对象的属性的选项。

Word.Shape

load(propertyNames)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 context.sync()。

load(propertyNames?: string | string[]): Word.Shape;

参数

propertyNames: string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

Word.Shape

load(propertyNamesAndPaths)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.Shape;

参数

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。

Word.Shape

moveHorizontally(distance)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

按磅数水平移动形状。

moveHorizontally(distance: number): void;

参数

distance: number

必填。指定形状水平移动的距离，以磅为单位。使用正值向右移动形状。使用负值向左移动形状。

void

注解

[ API 集：WordApi BETA (仅预览版) ]

moveVertically(distance)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

按磅数垂直移动形状。

moveVertically(distance: number): void;

参数

distance: number

必填。以磅为单位指定形状的垂直移动距离。使用正值向上移动形状。使用负值将形状向下移动。

void

注解

[ API 集：WordApi BETA (仅预览版) ]

select(selectMultipleShapes)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

选择形状。

select(selectMultipleShapes?: boolean): void;

参数

selectMultipleShapes: boolean

可选。是否选择多个浮动形状。默认值为 false。

void

注解

[ API 集：WordApi BETA (仅预览版) ]

set(properties, options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

同时设置对象的多个属性。可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。

set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void;

参数

properties: Word.Interfaces.ShapeUpdateData

一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。

options: OfficeExtension.UpdateOptions

提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

void

set(properties)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: Word.Shape): void;

参数

properties: Word.Shape

void

toJSON()

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的对象的方法。) 虽然原始Word.Shape对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Word.Interfaces.ShapeData) ，其中包含从原始对象加载的任何子属性的浅表副本。

toJSON(): Word.Interfaces.ShapeData;

Word.Interfaces.ShapeData

track()

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

根据文档中的相应更改来跟踪对象，以便进行自动调整。此调用是 context.trackedObjects.add (thisObject) 的简写。如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。如果此对象是集合的一部分，则还应跟踪父集合。

track(): Word.Shape;

Word.Shape

untrack()

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

释放与此对象关联的内存（如果先前已跟踪过）。此调用是 context.trackedObjects.remove (thisObject) 的简写。拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。在内存发布生效之前，需要调用 context.sync() 。

untrack(): Word.Shape;

Word.Shape

通过

Word.Shape class

注解

属性

方法

属性详细信息

body

属性值

注解

context

属性值

geometricShapeType

属性值

注解

height

属性值

注解

id

属性值

注解

left

属性值

注解

name

属性值

注解

relativeHorizontalPosition

属性值

注解

relativeVerticalPosition

属性值

注解

shapeGroup

属性值

注解

top

属性值

注解

type

属性值

注解

width

属性值

注解

方法详细信息

delete()

返回

注解

load(options)

参数

返回

load(propertyNames)

参数

返回

load(propertyNamesAndPaths)

参数

返回

moveHorizontally(distance)

参数

返回

注解

moveVertically(distance)

参数

返回

注解

select(selectMultipleShapes)

参数

返回

注解

set(properties, options)

参数

返回

set(properties)

参数

返回

toJSON()

返回

track()

返回

untrack()