SetDashPattern
Sets annotation dash pattern. 💡 The border style property must be set to "dashed".
Syntax
expression.SetDashPattern(pattern);
expression - A variable that represents a ApiBaseAnnotation class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| pattern | Required | number[] | A dash array defining a pattern of dashes and gaps to be used in drawing a dashed border. For example, a value of [3, 2] specifies a border drawn with 3-point dashes alternating with 2-point gaps. |
Returns
boolean
Example
Create a square annotation and set dash pattern for border in a PDF document.
// How to set dash pattern for an annotation in a PDF document?
// Set dash pattern and display the result in a PDF document.
let doc = Api.GetDocument();
let squareAnnot = Api.CreateSquareAnnot([10, 10, 160, 32]);
let page = doc.GetPage(0);
page.AddObject(squareAnnot);
squareAnnot.SetBorderStyle("dashed");
squareAnnot.SetDashPattern([8, 4, 4, 4]);