CreatePatternFill
Creates a pattern fill to apply to the object using the selected pattern as the object background.
Syntax
expression.CreatePatternFill(patternType, bgColor, fgColor);
expression - A variable that represents a Api class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| patternType | Required | PatternType | The pattern type used for the fill selected from one of the available pattern types. | |
| bgColor | Required | ApiColor | The background color used for the pattern creation. | |
| fgColor | Required | ApiColor | The foreground color used for the pattern creation. |
Returns
Example
Apply a pattern fill to a shape in a PDF.
// How do I add a pattern background to a drawing in a PDF?
// Fill a shape with a repeating pattern using custom colors in a PDF.
const doc = Api.GetDocument();
const page = doc.GetPage(0);
const fill = Api.CreatePatternFill("dashDnDiag", Api.RGB(255, 111, 61), Api.RGB(51, 51, 51));
const stroke = Api.CreateStroke(0, Api.CreateNoFill());
const drawing = Api.CreateShape("flowChartMagneticTape", 150 * 36000, 65 * 36000, fill, stroke);
drawing.SetPosition(608400, 1267200);
page.AddObject(drawing);