Skip to main content

GetDashPattern

Gets annotation dash pattern.

Syntax​

expression.GetDashPattern();

expression - A variable that represents a ApiBaseAnnotation class.

Parameters​

This method doesn't have any parameters.

Returns​

number[]

Example​

Create a square annotation and get its dash pattern in a PDF document.

// How to get the dash pattern for an annotation in a PDF document?

// Get the dash pattern and display the result in a PDF document.

let doc = Api.GetDocument();
let squareAnnot = Api.CreateSquareAnnot([10, 10, 160, 32]);
squareAnnot.SetBorderStyle("dashed");
squareAnnot.SetDashPattern([8, 4, 4, 4]);
let page = doc.GetPage(0);
page.AddObject(squareAnnot);
console.log(`Annotation dash pattern is: ${squareAnnot.GetDashPattern()}`);