Class: UnderlineAnnot

PDFNet. UnderlineAnnot


new UnderlineAnnot()

An Underline annotation shows as a line segment across the bottom of a word or a group of contiguous words.

Methods


<static> create(doc, pos)

Creates a new Underline annotation in the specified document.

Parameters:
Name Type Description
doc PDFNet.SDFDoc

A document to which the Underline annotation is added.

pos PDFNet.rect

A rectangle specifying the Underline annotation's bounds in default user space units.

Returns:

A promise that resolves to a newly created blank Underline annotation.

Type
PDFNet.UnderlineAnnot

<static> createFromAnnot(ann)

creates an Underline annotation and initializes it using given annotation object.

Parameters:
Name Type Description
ann PDFNet.Annot

Annot object used to initialize the Underline annotation.

Returns:

A promise that resolves to an object of type: "UnderlineAnnot"

Type
PDFNet.UnderlineAnnot

<static> createFromObj(d)

creates an Underline annotation and initializes it using given Cos/SDF object.

Parameters:
Name Type Description
d PDFNet.Obj

The Cos/SDF object to initialze the annotation with.

Returns:

A promise that resolves to an object of type: "UnderlineAnnot"

Type
PDFNet.UnderlineAnnot