PowerPoint.SlideLayoutCollection class

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

context: RequestContext;

属性值

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

readonly items: PowerPoint.SlideLayout[];

属性值

获取集合中的布局数。

getCount(): OfficeExtension.ClientResult<number>;

返回

集合中的布局数。

注解

[ API 集：PowerPointApi 1.3 ]

使用布局的唯一 ID 获取布局。

getItem(key: string): PowerPoint.SlideLayout;

参数

返回

具有唯一 ID 的布局。 如果不存在此类布局，则会引发错误。

注解

[ API 集：PowerPointApi 1.3 ]

使用集合中从零开始的索引获取布局。

getItemAt(index: number): PowerPoint.SlideLayout;

参数

返回

给定索引处的布局。 如果索引范围外，将引发错误。

注解

[ API 集：PowerPointApi 1.3 ]

使用布局的唯一 ID 获取布局。 如果不存在此类布局，则返回属性设置为 true 的对象 isNullObject 。 有关详细信息，请参阅 *OrNullObject 方法和属性。

getItemOrNullObject(id: string): PowerPoint.SlideLayout;

参数

返回

具有唯一 ID 的布局。

注解

[ API 集：PowerPointApi 1.3 ]

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

load(options?: PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideLayoutCollection;

参数

返回

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

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

参数

返回

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml

await PowerPoint.run(async function(context) {
  // Load information about all the slide masters and associated layouts.
  const slideMasters: PowerPoint.SlideMasterCollection = context.presentation.slideMasters.load("id, name, layouts/items/name, layouts/items/id");
  await context.sync();

  // Log the name and ID of each slide master.
  for (let i = 0; i < slideMasters.items.length; i++) {
    console.log("Master name: " + slideMasters.items[i].name);
    console.log("Master ID: " + slideMasters.items[i].id);

    // Log the name and ID of each slide layout in the slide master.
    const layoutsInMaster: PowerPoint.SlideLayoutCollection = slideMasters.items[i].layouts;
    for (let j = 0; j < layoutsInMaster.items.length; j++) {
      console.log("    Layout name: " + layoutsInMaster.items[j].name + " Layout ID: " + layoutsInMaster.items[j].id);
    }
  }
});

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

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

参数

返回

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

toJSON(): PowerPoint.Interfaces.SlideLayoutCollectionData;

返回