Skip to main content

GetFill

Gets the fill properties from the current shape.

Syntax​

expression.GetFill();

expression - A variable that represents a ApiShape class.

Parameters​

This method doesn't have any parameters.

Returns​

ApiFill | null

Example​

Read the background fill applied to a shape in a document.

// How do I inspect the color or gradient covering the inside of a shape in a document?

// Extract fill details from a shape to display its visual properties in a document.

let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
let gs1 = Api.CreateGradientStop(Api.CreateRGBColor(255, 213, 191), 0);
let gs2 = Api.CreateGradientStop(Api.CreateRGBColor(255, 111, 61), 100000);
let fill = Api.CreateLinearGradientFill([gs1, gs2], 5400000);
let stroke = Api.CreateStroke(0, Api.CreateNoFill());
let shape = Api.CreateShape("rect", 100 * 36000, 50 * 36000, fill, stroke);
paragraph.AddDrawing(shape);
paragraph.AddLineBreak();
let retrievedFill = shape.GetFill();
if (retrievedFill) {
    paragraph.AddText("Fill type: " + retrievedFill.GetType());
}