PowerPoint.SlideBackground class
表示幻灯片的背景。
注解
使用方
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/get-set-background-fill.yaml
// Gets the background fill type of the first selected slide.
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();
const fillType = fill.type as PowerPoint.SlideBackgroundFillType;
console.log(`Background fill type: ${fillType}`);
});
属性
| are |
指定幻灯片版式背景填充是隐藏还是显示幻灯片母版中的背景图形对象。 |
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| fill | 返回背景的填充格式。 |
| is |
指定幻灯片背景是否遵循幻灯片母版背景。 |
方法
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| reset() | 重置幻灯片背景的填充格式。 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
areBackgroundGraphicsHidden
指定幻灯片版式背景填充是隐藏还是显示幻灯片母版中的背景图形对象。
areBackgroundGraphicsHidden: boolean;属性值
boolean
注解
context
fill
返回背景的填充格式。
readonly fill: PowerPoint.SlideBackgroundFill;属性值
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/get-set-background-fill.yaml
// Gets the background fill type of the first selected slide.
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();
const fillType = fill.type as PowerPoint.SlideBackgroundFillType;
console.log(`Background fill type: ${fillType}`);
});
isMasterBackgroundFollowed
方法详细信息
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: PowerPoint.Interfaces.SlideBackgroundLoadOptions): PowerPoint.SlideBackground;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): PowerPoint.SlideBackground;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): PowerPoint.SlideBackground;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
reset()
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 PowerPoint.SlideBackground 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 PowerPoint.Interfaces.SlideBackgroundData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): PowerPoint.Interfaces.SlideBackgroundData;