PowerPoint.SlideBackgroundFill class

表示幻灯片背景对象的填充格式。

扩展

注解

[ API 集:PowerPointApi 1.10 ]

属性

context

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

type

返回幻灯片背景的填充类型。 有关详细信息,请参阅 PowerPoint.SlideBackgroundFillType

方法

getGradientFillOrNullObject()

获取渐变填充属性。 如果填充类型不是 gradient,则 isNullObject 返回属性设置为 true 的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

getPatternFillOrNullObject()

获取图案填充属性。 如果填充类型不是 pattern,则 isNullObject 返回属性设置为 true 的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

getPictureOrTextureFillOrNullObject()

获取图片或纹理填充属性。 如果填充类型不是 pictureOrTexture,则 isNullObject 返回属性设置为 true 的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

getSolidFillOrNullObject()

获取实心填充属性。 如果填充类型不是 solid,则 isNullObject 返回属性设置为 true 的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

setGradientFill(options)

将幻灯片背景的填充格式设置为渐变填充。 这会将填充类型更改为 gradient

setPatternFill(options)

将幻灯片背景的填充格式设置为图案填充。 这会将填充类型更改为 pattern

setPictureOrTextureFill(options)

将幻灯片背景的填充格式设置为图片或纹理填充。 这会将填充类型更改为 pictureOrTexture

setSolidFill(options)

将幻灯片背景的填充格式设置为纯色填充。 这会将填充类型更改为 solid

toJSON()

重写 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (,依次调用toJSON传递给它的 对象的 方法。) 虽然原始PowerPoint.SlideBackgroundFill对象是 API 对象,toJSON但该方法返回一个纯 JavaScript 对象, (类型为 PowerPoint.Interfaces.SlideBackgroundFillData) ,其中包含从原始对象加载的任何子属性的浅表副本。

属性详细信息

context

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

context: RequestContext;

属性值

type

返回幻灯片背景的填充类型。 有关详细信息,请参阅 PowerPoint.SlideBackgroundFillType

readonly type: PowerPoint.SlideBackgroundFillType | "Unsupported" | "Solid" | "Gradient" | "PictureOrTexture" | "Pattern";

属性值

PowerPoint.SlideBackgroundFillType | "Unsupported" | "Solid" | "Gradient" | "PictureOrTexture" | "Pattern"

注解

[ API 集:PowerPointApi 1.10 ]

方法详细信息

getGradientFillOrNullObject()

获取渐变填充属性。 如果填充类型不是 gradient,则 isNullObject 返回属性设置为 true 的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

getGradientFillOrNullObject(): PowerPoint.SlideBackgroundGradientFill;

返回

注解

[ API 集:PowerPointApi 1.10 ]

getPatternFillOrNullObject()

获取图案填充属性。 如果填充类型不是 pattern,则 isNullObject 返回属性设置为 true 的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

getPatternFillOrNullObject(): PowerPoint.SlideBackgroundPatternFill;

返回

注解

[ API 集:PowerPointApi 1.10 ]

getPictureOrTextureFillOrNullObject()

获取图片或纹理填充属性。 如果填充类型不是 pictureOrTexture,则 isNullObject 返回属性设置为 true 的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

getPictureOrTextureFillOrNullObject(): PowerPoint.SlideBackgroundPictureOrTextureFill;

返回

注解

[ API 集:PowerPointApi 1.10 ]

getSolidFillOrNullObject()

获取实心填充属性。 如果填充类型不是 solid,则 isNullObject 返回属性设置为 true 的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

getSolidFillOrNullObject(): PowerPoint.SlideBackgroundSolidFill;

返回

注解

[ API 集:PowerPointApi 1.10 ]

load(options)

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

load(options?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions): PowerPoint.SlideBackgroundFill;

参数

options
PowerPoint.Interfaces.SlideBackgroundFillLoadOptions

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

返回

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

setGradientFill(options)

将幻灯片背景的填充格式设置为渐变填充。 这会将填充类型更改为 gradient

setGradientFill(options?: PowerPoint.SlideBackgroundGradientFillOptions): void;

参数

options
PowerPoint.SlideBackgroundGradientFillOptions

渐变填充的选项。

返回

void

注解

[ API 集:PowerPointApi 1.10 ]

setPatternFill(options)

将幻灯片背景的填充格式设置为图案填充。 这会将填充类型更改为 pattern

setPatternFill(options?: PowerPoint.SlideBackgroundPatternFillOptions): void;

参数

options
PowerPoint.SlideBackgroundPatternFillOptions

图案填充选项。

返回

void

注解

[ API 集:PowerPointApi 1.10 ]

setPictureOrTextureFill(options)

将幻灯片背景的填充格式设置为图片或纹理填充。 这会将填充类型更改为 pictureOrTexture

setPictureOrTextureFill(options?: PowerPoint.SlideBackgroundPictureOrTextureFillOptions): void;

参数

options
PowerPoint.SlideBackgroundPictureOrTextureFillOptions

图片或纹理填充选项。

返回

void

注解

[ API 集:PowerPointApi 1.10 ]

setSolidFill(options)

将幻灯片背景的填充格式设置为纯色填充。 这会将填充类型更改为 solid

setSolidFill(options?: PowerPoint.SlideBackgroundSolidFillOptions): void;

参数

options
PowerPoint.SlideBackgroundSolidFillOptions

实心填充的选项。

返回

void

注解

[ API 集:PowerPointApi 1.10 ]

toJSON()

重写 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (,依次调用toJSON传递给它的 对象的 方法。) 虽然原始PowerPoint.SlideBackgroundFill对象是 API 对象,toJSON但该方法返回一个纯 JavaScript 对象, (类型为 PowerPoint.Interfaces.SlideBackgroundFillData) ,其中包含从原始对象加载的任何子属性的浅表副本。

toJSON(): PowerPoint.Interfaces.SlideBackgroundFillData;

返回