Foxit PDF SDK

Public Member Functions | List of all members
FSDK.TextLink Class Reference

## Public Member Functions
| GetEndCharIndex ()
| Get the index of last character of current hyper-link URI, based on PDF page. More...
| GetRects ()
| Get the text rectangles of current text link object. More...
| GetStartCharIndex ()
| Get the index of start character of current hyper-link URI, based on PDF page. More...
| GetURI ()
| Get URI string. More...
| 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 text link object is retrieved by function FSDK.PageTextLinks.GetTextLink.

See also
  FSDK.PageTextLinks

## Member Function Documentation

## ◆ GetEndCharIndex()

FSDK.TextLink.GetEndCharIndex | ( |  | ) |

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()

FSDK.TextLink.GetRects | ( |  | ) |

Get the text rectangles of current text link object.

Returns
  An array of rectangles.

## ◆ GetStartCharIndex()

FSDK.TextLink.GetStartCharIndex | ( |  | ) |

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()

FSDK.TextLink.GetURI | ( |  | ) |

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()

FSDK.TextLink.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.