Name
  pdf.GetPageLinks -- get all links on a PDF page (V1.1)
Synopsis

      t = pdf.GetPageLinks(id, page)

Function
  This function can be used to get all links from a PDF page. The page to use must be specified in the `page` argument. It must be a number in the range of 1 to the total number of pages in the document and it must have been loaded using pdf.LoadPage(). The PDF document specified by `id` must have been opened using pdf.OpenDocument().

  On return, `pdf.GetPageLinks()` will generate a table containing all links in the page. For each entry, the table will have the following fields initialized:

  `Action:`
    This field specifies what should happen if the respective link is clicked. This will be set to one of the following special constants:

    `#PDFACTION_GOTO:`
      Skip to page in current document.
    `#PDFACTION_REMOTEGOTO:`
      Skip to page in another document.
    `#PDFACTION_URI:`
      Open an URI.
    `#PDFACTION_LAUNCH:`
      Launch a program.
    `#PDFACTION_UNSUPPORTED:`
      Unknown action.

  `Target:`
    This will be set to the link's target. Depending on `Action`, this may be set to a page number, a URI, or the path to an external file.

  `Left:`
    Left edge of the link's bounding rectangle.

  `Top:`
    Top edge of the link's bounding rectangle.

  `Right:`
    Right edge of the link's bounding rectangle.

  `Bottom:`
    Bottom edge of the link's bounding rectangle.

Inputs
  id
    identifier of the PDF document to use
  page
    page number to use (starting from 1)
Results
  t
    table containing all page links (see above)

Show TOC