PowerPoint.PlaceholderFormat class

包:: powerpoint

表示形状的 placeholder 属性。

扩展: OfficeExtension.ClientObject

注解

使用方

PowerPoint.Shape： placeholderFormat

示例

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

// Gets the placeholder shapes in the slide.
await PowerPoint.run(async (context) => {
  // Get properties for every shape in the collection.
  const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
  shapes.load("type,name");
  await context.sync();

  const placeholderShapes = [];
  console.log(`Number of shapes found: ${shapes.items.length}`);
  shapes.items.forEach((shape) => {
    if (shape.type === PowerPoint.ShapeType.placeholder) {
      // Load placeholderFormat property.
      // PowerPoint throws an exception if you try to load this property on a shape that isn't a placeholder type.
      shape.load("placeholderFormat");
      placeholderShapes.push(shape);
    }
  });
  await context.sync();

  console.log(`Number of placeholder shapes found: ${placeholderShapes.length}`);
  for (let i = 0; i < placeholderShapes.length; i++) {
    let currentPlaceholder: PowerPoint.PlaceholderFormat = placeholderShapes[i].placeholderFormat;
    let placeholderType = currentPlaceholder.type as PowerPoint.PlaceholderType;
    let placeholderContainedType = currentPlaceholder.containedType as PowerPoint.ShapeType;
    console.log(`Shape "${placeholderShapes[i].name}" placeholder properties:`);
    console.log(`\ttype: ${placeholderType}`);
    console.log(`\tcontainedType: ${placeholderContainedType}`);
  }
});

属性

containedType	获取占位符中包含的形状的类型。有关详细信息，请参阅 PowerPoint.ShapeType 。如果占位符为空，则返回 `null` 。
context	与对象关联的请求上下文。这将加载项的进程连接到 Office 主机应用程序的进程。
type	返回此占位符的类型。有关详细信息，请参阅 PowerPoint.PlaceholderType 。

方法

load(options)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNames)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
toJSON()	覆盖 JavaScript `toJSON()` 方法，以便在将 API 对象传递给 `JSON.stringify()`时提供更有用的输出。 (`JSON.stringify`反过来调用 `toJSON` 传递给它的对象的方法。) 虽然原始 `PowerPoint.PlaceholderFormat` 对象是 API 对象， `toJSON` 但该方法返回一个纯 JavaScript 对象， (类型化为 `PowerPoint.Interfaces.PlaceholderFormatData`) ，其中包含从原始对象加载的任何子属性的浅层副本。

属性详细信息

containedType

获取占位符中包含的形状的类型。有关详细信息，请参阅 PowerPoint.ShapeType 。如果占位符为空，则返回 null 。

readonly containedType: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null;

属性值

注解

API 集：PowerPointApi 1.8

context

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

context: RequestContext;

属性值

PowerPoint.RequestContext

type

返回此占位符的类型。有关详细信息，请参阅 PowerPoint.PlaceholderType 。

readonly type: PowerPoint.PlaceholderType | "Unsupported" | "Date" | "SlideNumber" | "Footer" | "Header" | "Title" | "Body" | "CenterTitle" | "Subtitle" | "VerticalTitle" | "VerticalBody" | "Content" | "Chart" | "Table" | "OnlinePicture" | "SmartArt" | "Media" | "VerticalContent" | "Picture" | "Cameo";

属性值

注解

API 集：PowerPointApi 1.8

方法详细信息

load(options)

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

load(options?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions): PowerPoint.PlaceholderFormat;

参数

options: PowerPoint.Interfaces.PlaceholderFormatLoadOptions

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

PowerPoint.PlaceholderFormat

load(propertyNames)

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

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

参数

propertyNames: string | string[]

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

PowerPoint.PlaceholderFormat

load(propertyNamesAndPaths)

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

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

参数

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

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

PowerPoint.PlaceholderFormat

toJSON()

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

toJSON(): PowerPoint.Interfaces.PlaceholderFormatData;

PowerPoint.Interfaces.PlaceholderFormatData

反馈

此页面是否有帮助？