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​

Get intent of freeText annotation in a PDF document.

// How do I get the intent in a PDF document?

// Get the intent using a free text annotation object in a PDF document.

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()}`);