Class Index

Classes


Class PDFNet.HighlightAnnot

PDFNet.HighlightAnnot

Class Summary
Constructor Attributes Constructor Name and Description
 
A Highlight annotation covers a word or a group of contiguous words with partially transparent color.
Method Summary
Method Attributes Method Name and Description
<static>  
PDFNet.HighlightAnnot.create(doc, pos)
Creates a new Highlight annotation in the specified document.
<static>  
PDFNet.HighlightAnnot.createFromAnnot(ann)
creates a Highlight annotation and initializes it using given annotation object.
<static>  
PDFNet.HighlightAnnot.createFromObj(d)
creates a Highlight annotation and initializes it using given Cos/SDF object.
Class Detail
PDFNet.HighlightAnnot(id)
A Highlight annotation covers a word or a group of contiguous words with partially transparent color.
Parameters:
id
Method Detail
<static> {HighlightAnnot} PDFNet.HighlightAnnot.create(doc, pos)
Creates a new Highlight annotation in the specified document.
Parameters:
{SDFDoc} doc
A document to which the Highlight annotation is added.
{rect} pos
A rectangle specifying the Highlight annotation's bounds in default user space units.
Returns:
{HighlightAnnot} A promise that resolves to a newly created blank Highlight annotation.

<static> {HighlightAnnot} PDFNet.HighlightAnnot.createFromAnnot(ann)
creates a Highlight annotation and initializes it using given annotation object.
Parameters:
{Annot} ann
Annot object used to initialize the Highlight annotation.
Returns:
{HighlightAnnot} A promise that resolves to an object of type: "HighlightAnnot" (generated documentation)

<static> {HighlightAnnot} PDFNet.HighlightAnnot.createFromObj(d)
creates a Highlight annotation and initializes it using given Cos/SDF object.
Parameters:
{Obj} d
The Cos/SDF object to initialze the annotation with.
Returns:
{HighlightAnnot} A promise that resolves to an object of type: "HighlightAnnot" (generated documentation)

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Sep 09 2016 14:32:40 GMT-0700 (PDT)