PowerPoint.SlideScopedCollection class
表示演示文稿中的幻灯片集合。
- 扩展
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
// Saves which shapes are selected so that they can be reselected later.
await PowerPoint.run(async (context) => {
context.presentation.load("slides");
await context.sync();
const slides: PowerPoint.SlideScopedCollection = context.presentation.getSelectedSlides();
const slideCount = slides.getCount();
slides.load("items");
await context.sync();
savedSlideSelection = [];
slides.items.map((slide) => {
savedSlideSelection.push(slide.id);
});
const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
const shapeCount = shapes.getCount();
shapes.load("items");
await context.sync();
shapes.items.map((shape) => {
savedShapeSelection.push(shape.id);
});
});
属性
context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
items | 获取此集合中已加载的子项。 |
方法
get |
获取集合中的幻灯片数。 |
get |
使用幻灯片的唯一 ID 获取幻灯片。 |
get |
使用集合中从零开始的索引获取幻灯片。 |
get |
使用幻灯片的唯一 ID 获取幻灯片。 如果此类幻灯片不存在,则返回属性设置为 true 的对象 |
load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
toJSON() | 重写 JavaScript |
属性详细信息
context
items
方法详细信息
getCount()
获取集合中的幻灯片数。
getCount(): OfficeExtension.ClientResult<number>;
返回
OfficeExtension.ClientResult<number>
集合中的幻灯片数。
注解
getItem(key)
使用幻灯片的唯一 ID 获取幻灯片。
getItem(key: string): PowerPoint.Slide;
参数
- key
-
string
幻灯片的 ID。
返回
具有唯一 ID 的幻灯片。 如果不存在此类幻灯片,则会引发错误。
注解
getItemAt(index)
使用集合中从零开始的索引获取幻灯片。
getItemAt(index: number): PowerPoint.Slide;
参数
- index
-
number
集合中幻灯片的索引。
返回
给定索引处的幻灯片。 如果索引范围外,将引发错误。
注解
getItemOrNullObject(id)
使用幻灯片的唯一 ID 获取幻灯片。 如果此类幻灯片不存在,则返回属性设置为 true 的对象 isNullObject
。 有关详细信息,请参阅 *OrNullObject 方法和属性。
getItemOrNullObject(id: string): PowerPoint.Slide;
参数
- id
-
string
幻灯片的 ID。
返回
具有唯一 ID 的幻灯片。
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()
。
load(options?: PowerPoint.Interfaces.SlideScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideScopedCollection;
参数
- options
-
PowerPoint.Interfaces.SlideScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()
。
load(propertyNames?: string | string[]): PowerPoint.SlideScopedCollection;
参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()
。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideScopedCollection;
参数
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select
是一个逗号分隔的字符串,指定要加载的属性,是 propertyNamesAndPaths.expand
一个逗号分隔的字符串,指定要加载的导航属性。
返回
toJSON()
重写 JavaScript toJSON()
方法,以便在将 API 对象传递给 JSON.stringify()
时提供更有用的输出。
JSON.stringify
(,反过来,调用toJSON
传递给它的 对象的 方法。) 而原始PowerPoint.SlideScopedCollection
对象是 API 对象,toJSON
该方法返回一个纯 JavaScript 对象, (类型为 PowerPoint.Interfaces.SlideScopedCollectionData
) ,其中包含一个“items”数组,其中包含集合项中任何已加载属性的浅表副本。
toJSON(): PowerPoint.Interfaces.SlideScopedCollectionData;