FoxitPDFSDKforWeb  7.1.1
Foxit PDF SDK for Web
Link Class Reference

Link annot object. More...

Inheritance diagram for Link:
Annot

Public Member Functions

 getAction ()
 Get link's action. More...
 
 getHighlightingMode ()
 Get link's highlight mode. More...
 
 setHighlightingMode (highlightingMode)
 Set link's highlight mode. More...
 
- Public Member Functions inherited from Annot
 exportToJSON ()
 Export annotation to a json object. More...
 
 getBorderColor ()
 Get annotation's border color. More...
 
 getBorderInfo ()
 Get annotation's border information. More...
 
 getContent ()
 Get annotation's contents. More...
 
 getFlags ()
 Get annotation's flag. More...
 
 getModifiedDateTime ()
 Get annotation's last modified date time. More...
 
 getPage ()
 Get annotation's page. More...
 
 getRect ()
 Get annotation's rect. More...
 
 getTitle ()
 Get annotation's title. More...
 
 getType ()
 Get annotation's type. More...
 
 getUniqueID ()
 Get annotation's unique ID. More...
 
 isEmpty ()
 Check annotation is empty or not. More...
 
 isMarkup ()
 Check if current annotation is a markup annotation. More...
 
 setBorderColor (borderColor)
 Set annotation's border color. More...
 
 setBorderInfo (borderInfo)
 Set annotation's border information. More...
 
 setContent (content)
 Set annotation's contents. More...
 
 setFlags (flag)
 Set annotation's flag. More...
 
 setModifiedDateTime (date)
 Set annotation's last modified date time. 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 interge indecates highlight mode.
0 for none
1 for invert
2 for outline
3 for push
4 for toggle

◆ setHighlightingMode()

Link::setHighlightingMode (   highlightingMode)
inline

Set link's highlight mode.

Parameters
highlightingMode{number} - An interge indecates highlight mode, should be one of:
0 for none
1 for invert
2 for outline
3 for push
4 for toggle
Returns
{Promise.<T>}

Foxit Software Corporation Logo
@2019 Foxit Software Incorporated. All rights reserved.