PowerPoint.SlideBackgroundFill class

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Returns the fill type of the slide background. See PowerPoint.SlideBackgroundFillType for details.

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

Property Value

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Gets the gradient fill properties. If the fill type is not gradient, an object with an isNullObject property set to true is returned. For further information, see *OrNullObject methods and properties.

getGradientFillOrNullObject(): PowerPoint.SlideBackgroundGradientFill;

Returns

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Gets the pattern fill properties. If the fill type is not pattern, an object with an isNullObject property set to true is returned. For further information, see *OrNullObject methods and properties.

getPatternFillOrNullObject(): PowerPoint.SlideBackgroundPatternFill;

Returns

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Gets the picture or texture fill properties. If the fill type is not pictureOrTexture, an object with an isNullObject property set to true is returned. For further information, see *OrNullObject methods and properties.

getPictureOrTextureFillOrNullObject(): PowerPoint.SlideBackgroundPictureOrTextureFill;

Returns

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Gets the solid fill properties. If the fill type is not solid, an object with an isNullObject property set to true is returned. For further information, see *OrNullObject methods and properties.

getSolidFillOrNullObject(): PowerPoint.SlideBackgroundSolidFill;

Returns

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

Returns

Sets the fill formatting of the slide background to a gradient fill. This changes the fill type to gradient.

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

Parameters

Returns

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Sets the fill formatting of the slide background to a pattern fill. This changes the fill type to pattern.

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

Parameters

Returns

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Sets the fill formatting of the slide background to a picture or texture fill. This changes the fill type to pictureOrTexture.

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

Parameters

Returns

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Sets the fill formatting of the slide background to a solid fill. This changes the fill type to solid.

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

Parameters

Returns

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original PowerPoint.SlideBackgroundFill object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.SlideBackgroundFillData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): PowerPoint.Interfaces.SlideBackgroundFillData;

Returns