Word.Interfaces.ShapeCollectionLoadOptions interface

包:

word

注意

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

包含Word的集合。形状对象。 目前，仅支持以下形状：文本框、几何形状、分组形状和图片。

注解

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

属性

$all	$all为加载选项指定将加载所有标量属性 (（例如Range.address) ，但不加载导航属性 (如 Range.format.fill.color) ）。
body	对于集合中的每个项：表示形状的正文对象。 仅适用于文本框和几何形状。
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	对于集合中的每个项：形状的宽度（以磅为单位）。

属性详细信息

$all

注意

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

$all为加载选项指定将加载所有标量属性 (（例如Range.address) ，但不加载导航属性 (如 Range.format.fill.color) ）。

$all?: boolean;

属性值

boolean

body

注意

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

对于集合中的每个项：表示形状的正文对象。 仅适用于文本框和几何形状。

body?: Word.Interfaces.BodyLoadOptions;

属性值

Word.Interfaces.BodyLoadOptions

注解

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

geometricShapeType

注意

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

对于集合中的每个项：形状的几何形状类型。 如果 不是几何形状，则它将为 null。

geometricShapeType?: boolean;

属性值

boolean

注解

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

height

注意

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

对于集合中的每个项：形状的高度（以磅为单位）。

height?: boolean;

属性值

boolean

注解

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

id

注意

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

对于集合中的每个项：获取表示形状标识符的整数。

id?: boolean;

属性值

boolean

注解

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

left

注意

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

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

left?: boolean;

属性值

boolean

注解

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

name

注意

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

对于集合中的每个项：形状的名称。

name?: boolean;

属性值

boolean

注解

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

relativeHorizontalPosition

注意

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

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

relativeHorizontalPosition?: boolean;

属性值

boolean

注解

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

relativeVerticalPosition

注意

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

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

relativeVerticalPosition?: boolean;

属性值

boolean

注解

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

shapeGroup

注意

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

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

shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions;

属性值

Word.Interfaces.ShapeGroupLoadOptions

注解

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

top

注意

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

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

top?: boolean;

属性值

boolean

注解

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

type

注意

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

对于集合中的每个项：获取形状类型。 目前，仅支持以下形状：文本框、几何形状、分组形状和图片。

type?: boolean;

属性值

boolean

注解

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

width

注意

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

对于集合中的每个项：形状的宽度（以磅为单位）。

width?: boolean;

属性值

boolean

注解

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