PowerPoint.ShapeGroup class

包:

powerpoint

注意

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

表示演示文稿内的形状组。 若要获取相应的 Shape 对象，请使用 ShapeGroup.shape。

扩展

OfficeExtension.ClientObject

注解

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

属性

context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
id	获取形状组的唯一 ID。
shape	返回与 Shape 组关联的 对象。
shapes	返回组中对象的集合 Shape 。

方法

load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
toJSON()	重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 虽然原始PowerPoint.ShapeGroup对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 PowerPoint.Interfaces.ShapeGroupData) ，其中包含从原始对象加载的任何子属性的浅表副本。
ungroup()	取消分组指定形状组中的任何已分组形状。

属性详细信息

context

注意

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

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

context: RequestContext;

属性值

PowerPoint.RequestContext

id

注意

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

获取形状组的唯一 ID。

readonly id: string;

属性值

string

注解

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

shape

注意

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

返回与 Shape 组关联的 对象。

readonly shape: PowerPoint.Shape;

属性值

PowerPoint.Shape

注解

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

shapes

注意

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

返回组中对象的集合 Shape 。

readonly shapes: PowerPoint.ShapeScopedCollection;

属性值

PowerPoint.ShapeScopedCollection

注解

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

方法详细信息

load(options)

注意

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

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

load(options?: PowerPoint.Interfaces.ShapeGroupLoadOptions): PowerPoint.ShapeGroup;

参数

options

PowerPoint.Interfaces.ShapeGroupLoadOptions

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

返回

PowerPoint.ShapeGroup

load(propertyNames)

注意

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

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

load(propertyNames?: string | string[]): PowerPoint.ShapeGroup;

参数

propertyNames

string | string[]

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

返回

PowerPoint.ShapeGroup

load(propertyNamesAndPaths)

注意

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

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.ShapeGroup;

参数

propertyNamesAndPaths

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

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

返回

PowerPoint.ShapeGroup

toJSON()

注意

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

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

toJSON(): PowerPoint.Interfaces.ShapeGroupData;

返回

PowerPoint.Interfaces.ShapeGroupData

ungroup()

注意

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

取消分组指定形状组中的任何已分组形状。

ungroup(): void;

返回

void

注解

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