Word.Interfaces.ShapeCollectionLoadOptions interface

包含 Word 集合。形状对象。 目前仅支持以下形状:文本框、几何形状、组、图片和画布。

属性

$all

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

allowOverlap

For EACH ITEM in the collection:指定给定形状是否可以与其他形状重叠。

altTextDescription

对于集合中的每个项目: 指定表示与形状关联的可选文本的字符串。

body

对于集合中的每个项目: 获取 Body 形状的对象。 仅适用于文本框和几何形状。

canvas

For EACH ITEM in the collection: 获取与形状关联的画布。 如果形状类型不是 canvas,则将返回其isNullObject属性设置为 true 的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

fill

对于集合中的每个项:返回形状的填充格式。

geometricShapeType

For EACH ITEM in the collection: 指定形状的几何形状类型。 如果不是几何形状,则为 null。

height

对于集合中的每个项目: 指定形状的高度(以磅为单位)。

heightRelative

对于集合中的每个项目: 指定形状高度与相对垂直大小 ((即 relativeVerticalSize 属性) )的百分比。 对于内联或子形状,无法设置它。

id

For EACH ITEM in the collection: 获取表示形状标识符的整数。

isChild

对于集合中的每个项:检查此形状是组形状的子项还是画布形状的子项。

left

对于集合中的每个项目:指定从形状左侧到相对水平位置 (relativeHorizontalPosition 即属性) 的距离(以磅为单位)。 对于内联形状,它将返回 0,无法设置。 对于画布或组中的子形状,它相对于左上角。

leftRelative

对于集合中的每个项:指定从形状左侧到相对水平位置的相对左侧位置(即 relativeHorizontalalPosition 属性) (以百分比表示)。 对于内联或子形状,它将返回 0 且无法设置。

lockAspectRatio

For EACH ITEM in the collection:指定是否锁定此形状的纵横比。

name

对于集合中的每个项目: 指定形状的名称。

parentCanvas

对于集合中的每个项目:获取此子形状的顶层父画布形状。 如果它不是画布的子形状,则它将为 null。

parentGroup

For EACH ITEM in the collection: 获取此子形状的顶层父组形状。 如果不是组的子形状,则为 null。

relativeHorizontalPosition

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

relativeHorizontalSize

对于集合中的每个项目: 指定形状的相对水平大小。 与该属性一起使用 widthRelative 。 对于内联或子形状,无法设置它。

relativeVerticalPosition

For EACH ITEM in the collection: 指定形状的相对垂直位置。 对于内联形状,无法设置它。 有关详细信息,请参阅 Word。RelativeVerticalPosition.

relativeVerticalSize

对于集合中的每个项目: 指定形状的相对垂直大小。 与该属性一起使用 heightRelative 。 对于内联或子形状,无法设置它。

rotation

For EACH ITEM in the collection: 指定形状的旋转角度(以度为单位)。 不适用于画布形状。

shapeGroup

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

textFrame

对于集合中的每个项目: 获取 TextFrame 形状的对象。

textWrap

对于集合中的每个项:返回形状的文字环绕格式。

top

对于集合中的每个项:指定从形状的顶部边缘到相对垂直位置的距离(以 relativeVerticalPosition 磅为单位 (即属性) 。 对于内联形状,它将返回 0,无法设置。 对于画布或组中的子形状,它相对于左上角。

topRelative

对于集合中的每个项:指定从形状顶部边缘到相对垂直位置(即属性) )的百分比 (relativeVerticalPosition 。 对于内联或子形状,它将返回 0 且无法设置。

type

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

visible

For EACH ITEM in the collection: 指定形状是否可见。 不适用于内联形状。

width

For EACH ITEM in the collection: 指定形状的宽度(以磅为单位)。

widthRelative

对于集合中的每个项目: 指定形状宽度与相对水平大小的百分比 (即属性 relativeHorizontalSize) 。 对于内联或子形状,无法设置它。

属性详细信息

$all

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

$all?: boolean;

属性值

boolean

allowOverlap

For EACH ITEM in the collection:指定给定形状是否可以与其他形状重叠。

allowOverlap?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.2

altTextDescription

对于集合中的每个项目: 指定表示与形状关联的可选文本的字符串。

altTextDescription?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.2

body

对于集合中的每个项目: 获取 Body 形状的对象。 仅适用于文本框和几何形状。

body?: Word.Interfaces.BodyLoadOptions;

属性值

注解

API 集:WordApiDesktop 1.2

canvas

For EACH ITEM in the collection: 获取与形状关联的画布。 如果形状类型不是 canvas,则将返回其isNullObject属性设置为 true 的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

canvas?: Word.Interfaces.CanvasLoadOptions;

属性值

注解

API 集:WordApiDesktop 1.2

fill

对于集合中的每个项:返回形状的填充格式。

fill?: Word.Interfaces.ShapeFillLoadOptions;

属性值

注解

API 集:WordApiDesktop 1.2

geometricShapeType

For EACH ITEM in the collection: 指定形状的几何形状类型。 如果不是几何形状,则为 null。

geometricShapeType?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.2

height

对于集合中的每个项目: 指定形状的高度(以磅为单位)。

height?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.2

heightRelative

对于集合中的每个项目: 指定形状高度与相对垂直大小 ((即 relativeVerticalSize 属性) )的百分比。 对于内联或子形状,无法设置它。

heightRelative?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.2

id

For EACH ITEM in the collection: 获取表示形状标识符的整数。

id?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.2

isChild

对于集合中的每个项:检查此形状是组形状的子项还是画布形状的子项。

isChild?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.2

left

对于集合中的每个项目:指定从形状左侧到相对水平位置 (relativeHorizontalPosition 即属性) 的距离(以磅为单位)。 对于内联形状,它将返回 0,无法设置。 对于画布或组中的子形状,它相对于左上角。

left?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.2

leftRelative

对于集合中的每个项:指定从形状左侧到相对水平位置的相对左侧位置(即 relativeHorizontalalPosition 属性) (以百分比表示)。 对于内联或子形状,它将返回 0 且无法设置。

leftRelative?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.2

lockAspectRatio

For EACH ITEM in the collection:指定是否锁定此形状的纵横比。

lockAspectRatio?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.2

name

对于集合中的每个项目: 指定形状的名称。

name?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.2

parentCanvas

对于集合中的每个项目:获取此子形状的顶层父画布形状。 如果它不是画布的子形状,则它将为 null。

parentCanvas?: Word.Interfaces.ShapeLoadOptions;

属性值

注解

API 集:WordApiDesktop 1.2

parentGroup

For EACH ITEM in the collection: 获取此子形状的顶层父组形状。 如果不是组的子形状,则为 null。

parentGroup?: Word.Interfaces.ShapeLoadOptions;

属性值

注解

API 集:WordApiDesktop 1.2

relativeHorizontalPosition

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

relativeHorizontalPosition?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.2

relativeHorizontalSize

对于集合中的每个项目: 指定形状的相对水平大小。 与该属性一起使用 widthRelative 。 对于内联或子形状,无法设置它。

relativeHorizontalSize?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.2

relativeVerticalPosition

For EACH ITEM in the collection: 指定形状的相对垂直位置。 对于内联形状,无法设置它。 有关详细信息,请参阅 Word。RelativeVerticalPosition.

relativeVerticalPosition?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.2

relativeVerticalSize

对于集合中的每个项目: 指定形状的相对垂直大小。 与该属性一起使用 heightRelative 。 对于内联或子形状,无法设置它。

relativeVerticalSize?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.2

rotation

For EACH ITEM in the collection: 指定形状的旋转角度(以度为单位)。 不适用于画布形状。

rotation?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.2

shapeGroup

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

shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions;

属性值

注解

API 集:WordApiDesktop 1.2

textFrame

对于集合中的每个项目: 获取 TextFrame 形状的对象。

textFrame?: Word.Interfaces.TextFrameLoadOptions;

属性值

注解

API 集:WordApiDesktop 1.2

textWrap

对于集合中的每个项:返回形状的文字环绕格式。

textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions;

属性值

注解

API 集:WordApiDesktop 1.2

top

对于集合中的每个项:指定从形状的顶部边缘到相对垂直位置的距离(以 relativeVerticalPosition 磅为单位 (即属性) 。 对于内联形状,它将返回 0,无法设置。 对于画布或组中的子形状,它相对于左上角。

top?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.2

topRelative

对于集合中的每个项:指定从形状顶部边缘到相对垂直位置(即属性) )的百分比 (relativeVerticalPosition 。 对于内联或子形状,它将返回 0 且无法设置。

topRelative?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.2

type

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

type?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.2

visible

For EACH ITEM in the collection: 指定形状是否可见。 不适用于内联形状。

visible?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.2

width

For EACH ITEM in the collection: 指定形状的宽度(以磅为单位)。

width?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.2

widthRelative

对于集合中的每个项目: 指定形状宽度与相对水平大小的百分比 (即属性 relativeHorizontalSize) 。 对于内联或子形状,无法设置它。

widthRelative?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.2