Foxit PDF SDK

Public Member Functions | List of all members
FoxitPDFSDKPython2.PageTextLinks Class Reference
Inheritance diagram for FoxitPDFSDKPython2.PageTextLinks:

## Public Member Functions
def | PageTextLinks (other)
| Constructor, with another PageTextLinks object. More...
def | GetTextLink (index)
| Get a text link object by index. More...
def | GetTextLinkCount ()
| Get the count of the URL formatted texts, in related PDF page. More...
def | 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.

## Constructor & Destructor Documentation

## ◆ PageTextLinks()

def FoxitPDFSDKPython2.PageTextLinks.PageTextLinks | ( |  | other | ) |

Constructor, with another PageTextLinks object.

Parameters

  [in] | other | Another PageTextLinks object.

## Member Function Documentation

## ◆ GetTextLink()

def FoxitPDFSDKPython2.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 FoxitPDFSDKPython2.PageTextLinks.GetTextLinkCount .

Returns
  The specified text link object.

## ◆ GetTextLinkCount()

def FoxitPDFSDKPython2.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()

def FoxitPDFSDKPython2.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.