Skip to main content

GetBackground

Returns the background fill of the current slide layout.

Syntax​

expression.GetBackground();

expression - A variable that represents an ApiLayout class.

Parameters​

This method doesn't have any parameters.

Returns​

ApiFill | null

Example​

Return the background of the current slide layout.

const presentation = Api.GetPresentation();
const slide = presentation.GetSlideByIndex(0);
const master = presentation.GetMaster(0);
const layout = master.GetLayout(0);

const gs1 = Api.CreateGradientStop(Api.RGB(70, 50, 90), 0);
const gs2 = Api.CreateGradientStop(Api.RGB(40, 80, 100), 100000);
const fill = Api.CreateLinearGradientFill([gs1, gs2], 5400000);
layout.SetBackground(fill);

const bgFill = layout.GetBackground();
const classType = bgFill.GetClassType();

slide.RemoveAllObjects();
const stroke = Api.CreateStroke(0, Api.CreateNoFill());
const shape = Api.CreateShape(
	'rect',
	Api.MillimetersToEmus(120), Api.MillimetersToEmus(40),
	Api.CreateSolidFill(Api.RGB(50, 50, 65)),
	stroke
);
shape.SetPosition(Api.MillimetersToEmus(30), Api.MillimetersToEmus(30));

const content = shape.GetContent();
const paragraph = content.GetElement(0);
paragraph.AddText('Layout background fill class type: ' + classType);
slide.AddObject(shape);