Skip to main content

GetIntent

Gets intent type of this annotation.

Syntax​

expression.GetIntent();

expression - A variable that represents a ApiFreeTextAnnotation class.

Parameters​

This method doesn't have any parameters.

Returns​

FreeTextIntent

Example​

Determine the purpose or intent of a text annotation in a PDF.

// How do I find what type of comment mark was intended in a PDF?

// Check the annotation intent setting in a PDF.

let doc = Api.GetDocument();
let freeTextAnnot = Api.CreateFreeTextAnnot([160, 50, 360, 135]);
let page = doc.GetPage(0);
page.AddObject(freeTextAnnot);
freeTextAnnot.SetRectDiff([1, 1, 1, 1]);
console.log(`Annot intent is: ${freeTextAnnot.GetIntent()}`);