Skip to main content

CreateCaretAnnot

Creates caret annotation.

Syntax

expression.CreateCaretAnnot(rect);

expression - A variable that represents a Api class.

Parameters

NameRequired/OptionalData typeDefaultDescription
rectRequiredRect | Quad[]region to apply caret.

Returns

ApiCaretAnnotation

Example

Create a caret annotation and add it to the page.

// How do I create the caret annot in a PDF document?

// Create the caret annot and display the result in a PDF document.

let doc = Api.GetDocument();
let caretAnnot = Api.CreateCaretAnnot([[85.04985826771654,56.70000000000001,229.27237795275593,56.70000000000001,85.04985826771654,70.9988031496063,229.27237795275593,70.9988031496063]]);
let page = doc.GetPage(0);
page.AddObject(caretAnnot);