PowerPoint.SlideBackgroundSolidFill class

包:

powerpoint

表示 PowerPoint.SlideBackground 实体填充属性。

扩展

OfficeExtension.ClientObject

注解

API 集：PowerPointApi 1.10

使用方

• PowerPoint.SlideBackgroundFill： getSolidFillOrNullObject

示例

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

// Gets the solid fill properties of the first selected slide's background.
await PowerPoint.run(async (context) => {
  const slide: PowerPoint.Slide = context.presentation.getSelectedSlides().getItemAt(0);
  const fill: PowerPoint.SlideBackgroundFill = slide.background.fill;
  fill.load("type");
  await context.sync();

  if (fill.type !== PowerPoint.SlideBackgroundFillType.solid) {
    console.warn("The slide background isn't a solid fill.");
    return;
  }

  const solidFill: PowerPoint.SlideBackgroundSolidFill = slide.background.fill.getSolidFillOrNullObject();
  solidFill.load(["color", "transparency"]);
  await context.sync();

  if (solidFill.isNullObject) {
    console.warn("The slide background isn't a solid fill.");
  } else {
    console.log("Solid fill:", `- color: ${solidFill.color}`, `- transparency: ${solidFill.transparency}`);
  }
});

属性

color	以 HTML 颜色格式指定填充颜色 (例如“#FFA500”或“橙色”) 。
context	与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。
transparency	指定填充的透明度百分比，其值从 0.0 (不透明) 到 1.0 (透明) 。

方法

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

属性详细信息

color

以 HTML 颜色格式指定填充颜色 (例如“#FFA500”或“橙色”) 。

color: string;

属性值

string

注解

API 集：PowerPointApi 1.10

context

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

context: RequestContext;

属性值

PowerPoint.RequestContext

transparency

指定填充的透明度百分比，其值从 0.0 (不透明) 到 1.0 (透明) 。

transparency: number;

属性值

number

注解

API 集：PowerPointApi 1.10

方法详细信息

load(options)

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

load(options?: PowerPoint.Interfaces.SlideBackgroundSolidFillLoadOptions): PowerPoint.SlideBackgroundSolidFill;

参数

options

PowerPoint.Interfaces.SlideBackgroundSolidFillLoadOptions

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

返回

PowerPoint.SlideBackgroundSolidFill

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

PowerPoint.SlideBackgroundSolidFill

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

PowerPoint.SlideBackgroundSolidFill

toJSON()

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

toJSON(): PowerPoint.Interfaces.SlideBackgroundSolidFillData;

返回

PowerPoint.Interfaces.SlideBackgroundSolidFillData