Get Started
Documentation

CreateLinearGradientFill

CreateLinearGradientFill(aGradientStop, Angle) → {ApiFill}

Create a linear gradient fill which allows to fill the object using a selected linear gradient as the object background.

Parameters:

Name Type Description
aGradientStop Array The array of gradient color stops measured in 1000th of percent.
Angle PositiveFixedAngle The angle measured in 60000th of a degree that will define the gradient direction.

Returns:

Type
ApiFill

Example

Copy code
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oGs1, oGs2, oFill, oStroke, oDrawing, oParagraph;
oParagraph = oDocument.GetElement(0);
oGs1 = Api.CreateGradientStop(Api.CreateRGBColor(255, 224, 204), 0);
oGs2 = Api.CreateGradientStop(Api.CreateRGBColor(255, 164, 101), 100000);
oFill = Api.CreateLinearGradientFill([oGs1, oGs2], 5400000);
oStroke = Api.CreateStroke(0, Api.CreateNoFill());
oDrawing = Api.CreateShape("rect", 5930900, 395605, oFill, oStroke);
oParagraph.AddDrawing(oDrawing);
builder.SaveFile("docx", "CreateLinearGradientFill.docx");
builder.CloseFile();

Resulting document