Class PDFNet.TextMarkupAnnot
PDFNet.TextMarkupAnnot
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
A TextMarkup is a base class for highlight, underline,
strikeout, and squiggly annotations.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
PDFNet.TextMarkupAnnot.createFromAnnot(ann)
creates a TextMarkup annotation and initializes it using given annotation object.
|
| <static> |
PDFNet.TextMarkupAnnot.createFromObj(d)
creates a TextMarkup annotation and initializes it using given Cos/SDF object.
|
|
getQuadPoint(idx)
Returns the QuadPoint located at a certain index of the QuadPoint array.
|
|
|
Returns the number of QuadPoints in the QuadPoints array of the TextMarkup annotation
(PDF 1.6)
|
|
|
setQuadPoint(idx, qp)
sets the QuadPoint to be located at a certain index of the QuadPoint array.
|
Class Detail
PDFNet.TextMarkupAnnot(id)
A TextMarkup is a base class for highlight, underline,
strikeout, and squiggly annotations.
- Parameters:
- id
Method Detail
<static>
{TextMarkupAnnot}
PDFNet.TextMarkupAnnot.createFromAnnot(ann)
creates a TextMarkup annotation and initializes it using given annotation object.
- Parameters:
- {Annot} ann
- Annot object used to initialize the TextMarkup annotation.
- Returns:
- {TextMarkupAnnot} A promise that resolves to an object of type: "TextMarkupAnnot" (generated documentation)
<static>
{TextMarkupAnnot}
PDFNet.TextMarkupAnnot.createFromObj(d)
creates a TextMarkup annotation and initializes it using given Cos/SDF object.
- Parameters:
- {Obj} d
- The Cos/SDF object to initialze the annotation with.
- Returns:
- {TextMarkupAnnot} A promise that resolves to an object of type: "TextMarkupAnnot" (generated documentation)
{quadpoint}
getQuadPoint(idx)
Returns the QuadPoint located at a certain index of the QuadPoint array.
(PDF 1.6)
- Parameters:
- {number} idx
- The index where the QuadPoint is located. The index starts at zero and must be less than return value of GetQuadPointCount().
- Returns:
- {quadpoint} A promise that resolves to the QuadPoint located at a certain index of the QuadPoint array of the TextMarkup annotation.
{number}
getQuadPointCount()
Returns the number of QuadPoints in the QuadPoints array of the TextMarkup annotation
(PDF 1.6)
- Returns:
- {number} A promise that resolves to the number of QuadPoints.
setQuadPoint(idx, qp)
sets the QuadPoint to be located at a certain index of the QuadPoint array.
(Optional; PDF 1.6 )
- Parameters:
- {number} idx
- The index where the QuadPoint is to be located (the index is counted from 0).
- {quadpoint} qp
- The QuadPoint to be located at a certain index of the QuadPoint array of the TextMarkup annotation.