PowerPoint.CustomXmlPartScopedCollection class

包:

powerpoint

注意

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

自定义 XML 部件的作用域集合。 作用域内集合是某些操作 (（例如按命名空间) 筛选）的结果。 不能进一步限定范围集合的范围。

扩展

OfficeExtension.ClientObject

注解

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

属性

context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
items	获取此集合中已加载的子项。

方法

getCount()	获取此集合中的自定义 XML 部件数。
getItem(id)	CustomXmlPart根据 ID 获取 。
getItemOrNullObject(id)	CustomXmlPart根据 ID 获取 。 CustomXmlPart如果 不存在，则此方法返回一个 对象，其isNullObject属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getOnlyItem()	如果集合仅包含一个项，则此方法返回该项。 如果集合不包含任何项或多个项，则此方法返回错误 GeneralException 。
getOnlyItemOrNullObject()	如果集合仅包含一个项，则此方法返回该项。 否则，此方法返回 null。
load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
toJSON()	重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 虽然原始PowerPoint.CustomXmlPartScopedCollection对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 PowerPoint.Interfaces.CustomXmlPartScopedCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。

属性详细信息

context

注意

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

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

context: RequestContext;

属性值

PowerPoint.RequestContext

items

注意

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

获取此集合中已加载的子项。

readonly items: PowerPoint.CustomXmlPart[];

属性值

PowerPoint.CustomXmlPart[]

方法详细信息

getCount()

注意

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

获取此集合中的自定义 XML 部件数。

getCount(): OfficeExtension.ClientResult<number>;

返回

OfficeExtension.ClientResult<number>

集合中的自定义 XML 部件数。

注解

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

getItem(id)

注意

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

CustomXmlPart根据 ID 获取 。

getItem(id: string): PowerPoint.CustomXmlPart;

参数

id

string

要检索的对象 ID。

返回

PowerPoint.CustomXmlPart

注解

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

getItemOrNullObject(id)

注意

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

CustomXmlPart根据 ID 获取 。 CustomXmlPart如果 不存在，则此方法返回一个 对象，其isNullObject属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。

getItemOrNullObject(id: string): PowerPoint.CustomXmlPart;

参数

id

string

要检索的对象 ID。

返回

PowerPoint.CustomXmlPart

注解

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

getOnlyItem()

注意

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

如果集合仅包含一个项，则此方法返回该项。 如果集合不包含任何项或多个项，则此方法返回错误 GeneralException 。

getOnlyItem(): PowerPoint.CustomXmlPart;

返回

PowerPoint.CustomXmlPart

注解

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

getOnlyItemOrNullObject()

注意

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

如果集合仅包含一个项，则此方法返回该项。 否则，此方法返回 null。

getOnlyItemOrNullObject(): PowerPoint.CustomXmlPart;

返回

PowerPoint.CustomXmlPart

注解

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

load(options)

注意

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

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

load(options?: PowerPoint.Interfaces.CustomXmlPartScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomXmlPartScopedCollection;

参数

options

PowerPoint.Interfaces.CustomXmlPartScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

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

返回

PowerPoint.CustomXmlPartScopedCollection

load(propertyNames)

注意

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

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

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

参数

propertyNames

string | string[]

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

返回

PowerPoint.CustomXmlPartScopedCollection

load(propertyNamesAndPaths)

注意

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

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomXmlPartScopedCollection;

参数

propertyNamesAndPaths

OfficeExtension.LoadOption

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

返回

PowerPoint.CustomXmlPartScopedCollection

toJSON()

注意

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

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 虽然原始PowerPoint.CustomXmlPartScopedCollection对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 PowerPoint.Interfaces.CustomXmlPartScopedCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。

toJSON(): PowerPoint.Interfaces.CustomXmlPartScopedCollectionData;

返回

PowerPoint.Interfaces.CustomXmlPartScopedCollectionData