Link Class Reference

Link annot object. More...

Inheritance diagram for Link:

Public Member Functions
	getAction ()
	Get link's action. More...
	getHighlightingMode ()
	Get link's highlight mode. More...
	removeAction (trigger=-1, action)
	Remove link's action. More...
	setAction (action, trigger=actionType.AnnotMouseButtonReleased, append)
	Set link's action. More...
	setHighlightingMode (highlightingMode)
	Set link's highlight mode. More...
Public Member Functions inherited from Annot
	exportToJSON ()
	Export the current annotation to a Json object. [Support in Server] More...
	getBorderColor ()
	Get annotation's border color. [Support in Server] More...
	getBorderInfo ()
	Get annotation's border information. [Support in Server] More...
	getContent ()
	Get annotation's contents. [Support in Server] More...
	getDictionaryEntry (key)
	Get the dictionary property of Annot by key. More...
	getFlags ()
	Get annotation's flag. [Support in Server] More...
	getModifiedDateTime ()
	Get annotation's last modified date time. [Support in Server] More...
	getObjectNumber ()
	Get annotation's object number. More...
	getPage ()
	Get annotation's page. [Support in Server] More...
	getRect ()
	Get annotation's rect. [Support in Server] More...
	getTitle ()
	Get annotation's title. [Support in Server] More...
	getType ()
	Get annotation's type. [Support in Server] More...
	getUniqueID ()
	Get annotation's unique ID. [Support in Server] More...
	isEmpty ()
	Check annotation is empty or not. [Support in Server] More...
	isMarkup ()
	Check if current annotation is a markup annotation. [Support in Server] More...
	setBorderColor (borderColor)
	Set annotation's border color. [Support in Server] More...
	setBorderInfo (borderInfo)
	Set annotation's border information. [Support in Server] More...
	setContent (content)
	Set contents for the currently gotten annotation. [Support in Server] More...
	setDictionaryEntry (key, value)
	Add a new entry or replace the existing entry of the annotation dictionary. Caller could use this method to store their private data to the annotation. Do not use any standard key of the annotation dictionary, such as 'Type', 'Subtype', 'Rect' defined in PDF Reference. If any standard key is used, this behaviour will be undefined. More...
	setFlags (flag, notTriggerEvent)
	Set annotation's flag. [Support in Server] More...
	setModifiedDateTime (date)
	Set annotation's last modified date time. [Support in Server] More...
	setRect (rect)
	Set annotation's rect. More...

Detailed Description

Link annot object.

Member Function Documentation

getAction()

Link::getAction ( )

inline

Get link's action.

Returns

Action - An action object.

getHighlightingMode()

Link::getHighlightingMode ( )

inline

Get link's highlight mode.

Returns

number - An integer indicating highlight mode. Please refer to Highlight_Mode.

removeAction()

Link::removeAction (   trigger = -1,   action  )

inline

Remove link's action.

Returns

Promise<boolean> - A boolean value indicating the success or failure.

setAction()

Link::setAction (   action,   trigger = actionType.AnnotMouseButtonReleased,   append  )

inline

Set link's action.

Parameters

action

Action - New action to be set. It should be valid.

Returns

Promise<boolean> - A boolean value indicating the success or failure.

setHighlightingMode()

Link::setHighlightingMode (   highlightingMode )

inline

Set link's highlight mode.

Parameters

highlightingMode

number - An integer indicating highlight mode. Please refer to Highlight_Mode.

Returns

Promise<void>