Class PDFNet.LinkAnnot
PDFNet.LinkAnnot
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
PDFNet.LinkAnnot(id)
A link annotation represents either a hypertext link to a destination elsewhere in the document
or an action to be performed.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
PDFNet.LinkAnnot.create(doc, pos)
Creates a new Link annotation in the specified document.
|
| <static> |
PDFNet.LinkAnnot.createFromAnnot(ann)
creates a Link annotation and initializes it using given annotation object.
|
| <static> |
PDFNet.LinkAnnot.createFromObj(d)
creates a Link annotation and initializes it using given Cos/SDF object.
|
|
Returns the Action of the Link Annotation.
|
|
|
Returns the highlighting mode of this Link annotation.
|
|
|
getQuadPoint(idx)
Returns the QuadPoint located at a certain index of the QuadPoint array of the Link
annotation.
|
|
|
Returns the number of QuadPoints in the 'QuadPoints' array of the Link annotation.
|
|
|
removes this annotation's action.
|
|
|
setAction(action)
sets the Action of the Link Annotation.
|
|
|
setHighlightingMode(value)
Sets the highlighting mode for this Link annotation.
|
|
|
setQuadPoint(idx, qp)
set the QuadPoint to be located at a certain index of the QuadPoint array of the Link annotation.
|
Class Detail
PDFNet.LinkAnnot(id)
A link annotation represents either a hypertext link to a destination elsewhere in the document
or an action to be performed.
- Parameters:
- id
Method Detail
<static>
{LinkAnnot}
PDFNet.LinkAnnot.create(doc, pos)
Creates a new Link annotation in the specified document.
- Parameters:
- {SDFDoc} doc
- A document to which the Link annotation is added.
- {rect} pos
- A rectangle specifying the Link annotation's bounds in default user space units.
- Returns:
- {LinkAnnot} A promise that resolves to a newly created blank Link annotation.
<static>
{LinkAnnot}
PDFNet.LinkAnnot.createFromAnnot(ann)
creates a Link annotation and initializes it using given annotation object.
- Parameters:
- {Annot} ann
- Annot object used to initialize the Link annotation.
- Returns:
- {LinkAnnot} A promise that resolves to an object of type: "LinkAnnot" (generated documentation)
<static>
{LinkAnnot}
PDFNet.LinkAnnot.createFromObj(d)
creates a Link annotation and initializes it using given Cos/SDF object.
- Parameters:
- {Obj} d
- The Cos/SDF object to initialze the annotation with.
- Returns:
- {LinkAnnot} A promise that resolves to an object of type: "LinkAnnot" (generated documentation)
{Action}
getAction()
Returns the Action of the Link Annotation.
- Returns:
- {Action} A promise that resolves to an Action object of the Link annotation.
{number}
getHighlightingMode()
Returns the highlighting mode of this Link annotation.
Return value enum:
PDFNet.LinkAnnot.HighlightingMode = {
e_none : 0
e_invert : 1
e_outline : 2
e_push : 3
}
- Returns:
- {number} A promise that resolves to the highLighting mode as a value of the enum "HighlightingMode".
{quadpoint}
getQuadPoint(idx)
Returns the QuadPoint located at a certain index of the QuadPoint array of the Link
annotation.
- Parameters:
- {number} idx
- The index of the QuadPoint, starts at zero and should be less than the return value of GetQuadPointCount().
- Returns:
- {quadpoint} A promise that resolves to the QuadPoint located at a certain index of the QuadPoint array of the Link annotation.
{number}
getQuadPointCount()
Returns the number of QuadPoints in the 'QuadPoints' array of the Link annotation.
- Returns:
- {number} A promise that resolves to the number of QuadPoints.
removeAction()
removes this annotation's action.
setAction(action)
sets the Action of the Link Annotation.
(Optional; PDF 1.1 )
- Parameters:
- {Action} action
- An Action object that shall be associated with this Link annotation.
setHighlightingMode(value)
Sets the highlighting mode for this Link annotation.
(Optional; PDF 1.2 )
- Parameters:
- {number} value
- the mode as a value of the enum "HighlightingMode".
setQuadPoint(idx, qp)
set the QuadPoint to be located at a certain index of the QuadPoint array of the Link annotation.
(Optional; PDF 1.6 )
- Parameters:
- {number} idx
- The index of the QuadPoint, starts at zero and should be less than the return value of GetQuadPointCount().
- {quadpoint} qp
- The QuadPoint to be stored in the annotation.