PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions interface

表示形状的集合。

注解

[ API 集:PowerPointApi 1.5 ]

属性

$all

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

adjustments

对于集合中的每个项:返回一个 Adjustments 对象,该对象包含此形状中所有调整的调整值。

altTextDescription

对于集合中的每个项:形状的替换文字说明。

替换文字提供形状中包含的信息的基于文本的替代表示形式。 此信息对于可能无法看到或理解形状的视力或认知障碍人士非常有用。

altTextTitle

对于集合中的每个项:形状的替换文字标题。

替换文字提供形状中包含的信息的基于文本的替代表示形式。 此信息对于可能无法看到或理解形状的视力或认知障碍人士非常有用。 游戏可以读给残障人士,并用于确定是否要听到内容的说明。

creationId

对于集合中的每个项:获取形状的创建 ID。 null如果形状没有创建 ID,则返回 。

fill

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

group

对于集合中的每个项:返回 ShapeGroup 与形状关联的 。 如果形状类型不是 group,则此方法返回 GeneralException 错误。

height

对于集合中的每个项:指定形状的高度(以磅为单位)。 InvalidArgument使用负值设置时引发异常。

id

对于集合中的每个项:获取形状的唯一 ID。

isDecorative

对于集合中的每个项:表示形状是否具有装饰性。

装饰性对象可增加视觉兴趣,但不 (例如风格边框) 。 使用屏幕阅读器人员将听到这些是装饰性的,因此他们知道它们不会丢失任何重要信息。

left

对于集合中的每个项:从形状左侧到幻灯片左侧的距离(以磅为单位)。

level

对于集合中的每个项:返回指定形状的级别。

  • 级别为 0 表示形状不是组的一部分。

  • 级别为 1 表示形状是顶级组的一部分。

  • 大于 1 的级别指示形状是嵌套组。

lineFormat

对于集合中的每个项:返回此形状的线条格式。

name

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

parentGroup

对于集合中的每个项:返回此形状的父组。 如果形状不是组的一部分,则此方法返回 GeneralException 错误。

placeholderFormat

对于集合中的每个项:返回专门应用于此占位符的属性。 如果形状类型不是 placeholder,则此方法返回 GeneralException 错误。

rotation

对于集合中的每个项:指定围绕 z 轴的形状的旋转(以度为单位)。 正值表示顺时针旋转,负值表示逆时针旋转。

textFrame

对于集合中的每个项:返回此 ShapePowerPoint.TextFrame 对象。 InvalidArgument如果形状不支持 ,TextFrame则引发异常。

top

对于集合中的每个项目:从形状上边缘到幻灯片上边缘的距离(以磅为单位)。

type

对于集合中的每个项:返回此形状的类型。 有关详细信息,请参阅 PowerPoint.ShapeType

visible

对于集合中的每个项:指定形状是否可见。

width

对于集合中的每个项:指定形状的宽度(以磅为单位)。 InvalidArgument使用负值设置时引发异常。

zOrderPosition

对于集合中的每个项:返回形状的 z 顺序位置,0 表示顺序堆栈的底部。 幻灯片上的每个形状都有唯一的 z 顺序,但每张幻灯片也有唯一的 z 顺序堆栈,因此,单独幻灯片上的两个形状可能具有相同的 z 顺序编号。

属性详细信息

$all

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

$all?: boolean;

属性值

boolean

adjustments

注意

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

对于集合中的每个项:返回一个 Adjustments 对象,该对象包含此形状中所有调整的调整值。

adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;

属性值

注解

[ API 集:PowerPointApi BETA (仅预览版) ]

altTextDescription

注意

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

对于集合中的每个项:形状的替换文字说明。

替换文字提供形状中包含的信息的基于文本的替代表示形式。 此信息对于可能无法看到或理解形状的视力或认知障碍人士非常有用。

altTextDescription?: boolean;

属性值

boolean

注解

[ API 集:PowerPointApi BETA (仅预览版) ]

altTextTitle

注意

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

对于集合中的每个项:形状的替换文字标题。

替换文字提供形状中包含的信息的基于文本的替代表示形式。 此信息对于可能无法看到或理解形状的视力或认知障碍人士非常有用。 游戏可以读给残障人士,并用于确定是否要听到内容的说明。

altTextTitle?: boolean;

属性值

boolean

注解

[ API 集:PowerPointApi BETA (仅预览版) ]

creationId

注意

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

对于集合中的每个项:获取形状的创建 ID。 null如果形状没有创建 ID,则返回 。

creationId?: boolean;

属性值

boolean

注解

[ API 集:PowerPointApi BETA (仅预览版) ]

fill

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

fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;

属性值

注解

[ API 集:PowerPointApi 1.5 ]

group

对于集合中的每个项:返回 ShapeGroup 与形状关联的 。 如果形状类型不是 group,则此方法返回 GeneralException 错误。

group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;

属性值

注解

[ API 集:PowerPointApi 1.8 ]

height

对于集合中的每个项:指定形状的高度(以磅为单位)。 InvalidArgument使用负值设置时引发异常。

height?: boolean;

属性值

boolean

注解

[ API 集:PowerPointApi 1.4 ]

id

对于集合中的每个项:获取形状的唯一 ID。

id?: boolean;

属性值

boolean

注解

[ API 集:PowerPointApi 1.3 ]

isDecorative

注意

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

对于集合中的每个项:表示形状是否具有装饰性。

装饰性对象可增加视觉兴趣,但不 (例如风格边框) 。 使用屏幕阅读器人员将听到这些是装饰性的,因此他们知道它们不会丢失任何重要信息。

isDecorative?: boolean;

属性值

boolean

注解

[ API 集:PowerPointApi BETA (仅预览版) ]

left

对于集合中的每个项:从形状左侧到幻灯片左侧的距离(以磅为单位)。

left?: boolean;

属性值

boolean

注解

[ API 集:PowerPointApi 1.4 ]

level

对于集合中的每个项:返回指定形状的级别。

  • 级别为 0 表示形状不是组的一部分。

  • 级别为 1 表示形状是顶级组的一部分。

  • 大于 1 的级别指示形状是嵌套组。

level?: boolean;

属性值

boolean

注解

[ API 集:PowerPointApi 1.8 ]

lineFormat

对于集合中的每个项:返回此形状的线条格式。

lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;

属性值

注解

[ API 集:PowerPointApi 1.5 ]

name

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

name?: boolean;

属性值

boolean

注解

[ API 集:PowerPointApi 1.4 ]

parentGroup

对于集合中的每个项:返回此形状的父组。 如果形状不是组的一部分,则此方法返回 GeneralException 错误。

parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;

属性值

注解

[ API 集:PowerPointApi 1.8 ]

placeholderFormat

对于集合中的每个项:返回专门应用于此占位符的属性。 如果形状类型不是 placeholder,则此方法返回 GeneralException 错误。

placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;

属性值

注解

[ API 集:PowerPointApi 1.8 ]

rotation

注意

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

对于集合中的每个项:指定围绕 z 轴的形状的旋转(以度为单位)。 正值表示顺时针旋转,负值表示逆时针旋转。

rotation?: boolean;

属性值

boolean

注解

[ API 集:PowerPointApi BETA (仅预览版) ]

textFrame

对于集合中的每个项:返回此 ShapePowerPoint.TextFrame 对象。 InvalidArgument如果形状不支持 ,TextFrame则引发异常。

textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;

属性值

注解

[ API 集:PowerPointApi 1.5 ]

top

对于集合中的每个项目:从形状上边缘到幻灯片上边缘的距离(以磅为单位)。

top?: boolean;

属性值

boolean

注解

[ API 集:PowerPointApi 1.4 ]

type

对于集合中的每个项:返回此形状的类型。 有关详细信息,请参阅 PowerPoint.ShapeType

type?: boolean;

属性值

boolean

注解

[ API 集:PowerPointApi 1.4 ]

visible

注意

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

对于集合中的每个项:指定形状是否可见。

visible?: boolean;

属性值

boolean

注解

[ API 集:PowerPointApi BETA (仅预览版) ]

width

对于集合中的每个项:指定形状的宽度(以磅为单位)。 InvalidArgument使用负值设置时引发异常。

width?: boolean;

属性值

boolean

注解

[ API 集:PowerPointApi 1.4 ]

zOrderPosition

对于集合中的每个项:返回形状的 z 顺序位置,0 表示顺序堆栈的底部。 幻灯片上的每个形状都有唯一的 z 顺序,但每张幻灯片也有唯一的 z 顺序堆栈,因此,单独幻灯片上的两个形状可能具有相同的 z 顺序编号。

zOrderPosition?: boolean;

属性值

boolean

注解

[ API 集:PowerPointApi 1.8 ]