Foxit PDF RDK

Public Member Functions | List of all members
PageTextLinks Class Reference

## Public Member Functions
| constructor (page)
| Constructor, from a parsed PDF page. More...
| GetTextLink (index)
| Get a text link object by index. More...
| GetTextLinkCount ()
| Get the count of the URL formatted texts, in related PDF page. More...
| 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 PageTextLinks is used to manage these kind of text content as text links.

## Member Function Documentation

## ◆ constructor()

PageTextLinks.constructor | ( | page |  | ) |

Constructor, from a parsed PDF page.

Parameters

  [in] | page | A valid PDF page object. This page should has been parsed.

## ◆ GetTextLink()

PageTextLinks.GetTextLink | ( | index |  | ) |

Get a text link object by index.

Parameters

  [in] | index | Index 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()

PageTextLinks.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.

## ◆ IsEmpty()

PageTextLinks.IsEmpty | ( |  | ) |

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.