Edit

Share via


PowerPoint.Interfaces.SlideBackgroundLoadOptions interface

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents a background of a slide.

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

areBackgroundGraphicsHidden

Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.

fill

Returns the fill formatting of the background.

isMasterBackgroundFollowed

Specifies if the slide background follows the slide master background.

Property Details

$all

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

areBackgroundGraphicsHidden

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.

areBackgroundGraphicsHidden?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

fill

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Returns the fill formatting of the background.

fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;

Property Value

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

isMasterBackgroundFollowed

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies if the slide background follows the slide master background.

isMasterBackgroundFollowed?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]