Foxit PDF SDK
FSPageTextLinks Class Reference
Inheritance diagram for FSPageTextLinks:
FSBase

Instance Methods

(FSTextLink *) - getTextLink:
 Get a text link object by index.
More...
 
(int) - getTextLinkCount
 Get the count of the URL formatted texts, in related PDF page.
More...
 
(id) - initWithOther:
 Constructor, with another FSPageTextLinks object.
More...
 
(id) - initWithPage:
 Constructor, from a parsed PDF page.
More...
 
(BOOL) - isEmpty
 Check whether current object is empty or not.
More...
 

Detailed Description

In a PDF page, some text content may represent a hypertext link to a website or a resource on the internet, or an e-mail address. Class FSPageTextLinks is used to manage these kind of text content as text links.

Method Documentation

◆ getTextLink:()

- (FSTextLink *) getTextLink: (int)  index

Get a text link object by index.

Parameters
[in]indexIndex of a text link object. Valid range: from 0 to (count-1). count is returned by function PageTextLinks::getTextLinkCount.
Returns
The specified text link object.

◆ getTextLinkCount()

- (int) getTextLinkCount

Get the count of the URL formatted texts, in related PDF page.

Returns
The count of the text links, if returned -1 means error on the construct.

◆ initWithOther:()

- (id) initWithOther: (FSPageTextLinks*)  other

Constructor, with another FSPageTextLinks object.

Parameters
[in]otherAnother FSPageTextLinks object.

◆ initWithPage:()

- (id) initWithPage: (FSTextPage*)  page

Constructor, from a parsed PDF page.

Parameters
[in]pageA valid PDF page object. This page should has been parsed.

◆ isEmpty()

- (BOOL) isEmpty

Check whether current object is empty or not.

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

Returns
YES means current object is empty, while NO means not.