PowerPoint.Slide class

  • 参考
包:
powerpoint

表示演示文稿的一张幻灯片。

Extends
OfficeExtension.ClientObject

注解

[ API 集：PowerPointApi 1.2 ]

属性

context

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

获取幻灯片的唯一 ID。
layout

获取幻灯片的版式。
shapes

返回幻灯片中形状的集合。
slideMaster

获取 SlideMaster 表示幻灯片的默认内容的对象。
tags

返回幻灯片中的标记集合。

方法

delete()

从演示文稿中删除幻灯片。 如果幻灯片不存在，则不执行任何操作。
exportAsBase64()

将幻灯片导出到其自己的演示文稿文件，作为 base64 编码数据返回。
getImageAsBase64(options)

呈现幻灯片的图像。 将缩放图像以适合所需的尺寸。 如果未指定宽度和高度，则使用幻灯片的真实大小。 如果只指定了宽度或高度中的一个，则会计算另一个以保留纵横比。
load(options)

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

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

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

选择指定的形状。 现有形状选择将替换为新选定内容。
toJSON()

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

属性详细信息

context

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

context: RequestContext;

属性值

PowerPoint.RequestContext

id

获取幻灯片的唯一 ID。

readonly id: string;

属性值

string

注解

[ API 集：PowerPointApi 1.2 ]

layout

获取幻灯片的版式。

readonly layout: PowerPoint.SlideLayout;

属性值

PowerPoint.SlideLayout

注解

[ API 集：PowerPointApi 1.3 ]

shapes

返回幻灯片中形状的集合。

readonly shapes: PowerPoint.ShapeCollection;

属性值

PowerPoint.ShapeCollection

注解

[ API 集：PowerPointApi 1.3 ]

slideMaster

获取 SlideMaster 表示幻灯片的默认内容的对象。

readonly slideMaster: PowerPoint.SlideMaster;

属性值

PowerPoint.SlideMaster

注解

[ API 集：PowerPointApi 1.3 ]

tags

返回幻灯片中的标记集合。

readonly tags: PowerPoint.TagCollection;

属性值

PowerPoint.TagCollection

注解

[ API 集：PowerPointApi 1.3 ]

方法详细信息

delete()

从演示文稿中删除幻灯片。 如果幻灯片不存在，则不执行任何操作。

delete(): void;

返回

void

注解

[ API 集：PowerPointApi 1.2 ]

示例

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

// Deletes the selected slides.
await PowerPoint.run(async (context) => {
  context.presentation.load("slides");
  await context.sync();
  const slides = context.presentation.getSelectedSlides();
  const slideCount = slides.getCount();
  slides.load("items");
  await context.sync();
  slides.items.map((slide) => {
    slide.delete();
  });
});

exportAsBase64()

注意

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

将幻灯片导出到其自己的演示文稿文件，作为 base64 编码数据返回。

exportAsBase64(): OfficeExtension.ClientResult<string>;

返回

OfficeExtension.ClientResult<string>

注解

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

getImageAsBase64(options)

注意

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

呈现幻灯片的图像。 将缩放图像以适合所需的尺寸。 如果未指定宽度和高度，则使用幻灯片的真实大小。 如果只指定了宽度或高度中的一个，则会计算另一个以保留纵横比。

getImageAsBase64(options?: PowerPoint.SlideGetImageOptions): OfficeExtension.ClientResult<string>;

参数

options
PowerPoint.SlideGetImageOptions

可选。 用于指定所需幻灯片图像大小的选项。

返回

OfficeExtension.ClientResult<string>

PNG 格式幻灯片图像的 base64 字符串。

注解

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

load(options)

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

load(options?: PowerPoint.Interfaces.SlideLoadOptions): PowerPoint.Slide;

参数

options
PowerPoint.Interfaces.SlideLoadOptions

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

返回

PowerPoint.Slide

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

PowerPoint.Slide

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

PowerPoint.Slide

setSelectedShapes(shapeIds)

选择指定的形状。 现有形状选择将替换为新选定内容。

setSelectedShapes(shapeIds: string[]): void;

参数

shapeIds

string[]

在幻灯片中选择的形状 ID 列表。 如果列表为空，则清除所选内容。

返回

void

注解

[ API 集：PowerPointApi 1.5 ]

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml

// Reselects shapes that were saved previously.
await PowerPoint.run(async (context) => {
  const slide1 = context.presentation.slides.getItem(savedSlideSelection[0]);
  await context.sync();
  slide1.setSelectedShapes(savedShapeSelection);
  await context.sync();
});

...

// Selects the first two shapes on slide 1.
await PowerPoint.run(async (context) => {
  context.presentation.load("slides");
  await context.sync();
  const slide1 = context.presentation.slides.getItemAt(0);
  slide1.load("shapes");
  await context.sync();
  const shapes = slide1.shapes;
  const shape1 = shapes.getItemAt(0);
  const shape2 = shapes.getItemAt(1);
  shape1.load("id");
  shape2.load("id");
  await context.sync();
  slide1.setSelectedShapes([shape1.id, shape2.id]);
  await context.sync();
});

toJSON()

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

toJSON(): PowerPoint.Interfaces.SlideData;

返回

PowerPoint.Interfaces.SlideData