foxit.pdf.TextLink Class Reference
Inheritance diagram for foxit.pdf.TextLink:
foxit.common.Base

Public Member Functions

 TextLink (TextLink other)
 Constructor, with another TextLink object.

 
int GetEndCharIndex ()
 Get the index of last character of current hyper-link URI, based on PDF page.
More...
 
RectFArray GetRects ()
 Get the text rectangles of current text link object.
More...
 
int GetStartCharIndex ()
 Get the index of start character of current hyper-link URI, based on PDF page.
More...
 
string GetURI ()
 Get URI string.
More...
 
bool IsEmpty ()
 Check whether current object is empty or not.
More...
 

Detailed Description

A text link is just text content, which represents a hypertext link to a website or a resource on the internet, or an e-mail address.
This class offers functions to get information from the text link.
A TextLink object is retrieved by function PageTextLinks::GetTextLink.

See also
PageTextLinks

Member Function Documentation

◆ GetEndCharIndex()

int foxit.pdf.TextLink.GetEndCharIndex ( )
inline

Get the index of last character of current hyper-link URI, based on PDF page.

Returns
The index of last character, starting from 0.

◆ GetRects()

RectFArray foxit.pdf.TextLink.GetRects ( )
inline

Get the text rectangles of current text link object.

Returns
An array of rectangles.

◆ GetStartCharIndex()

int foxit.pdf.TextLink.GetStartCharIndex ( )
inline

Get the index of start character of current hyper-link URI, based on PDF page.

Returns
The index of start character, starting from 0.

◆ GetURI()

string foxit.pdf.TextLink.GetURI ( )
inline

Get URI string.

A text link's URI can be a hypertext link to a website or a resource on the internet. It can also be an e-mail address.

Returns
URI string.

◆ IsEmpty()

bool foxit.pdf.TextLink.IsEmpty ( )
inline

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.

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