XPDFViewer_Get

Typefunction
DictionaryLCS
LibraryLiveCode Script
Syntax
XPDFViewer_Get(<viewerName>, <property>)
Associationsxpdf
Summary

Get the value of a property from a PDF Viewer.

EditionBusiness
Introduced1.0.0
OSmac, windows
Platformsdesktop
Parameters
NameTypeDescription
viewerName

The name of the viewer.

property

The name of the property to get.

Example
put XPDFViewer_Get("Document1", "rect") into thePDFRect
Values
NameTypeDescription
return

The value of the property.

Description

Set the following properties:

  • rect - The rect of the PDF Viewer relative to the top left of the stack window.
  • fileName - The full file path to the PDF file being viewed
  • visible - The visibility of the PDF Viewer
  • pageNumber - The currently displayed page of the PDF Viewer
  • formattedWidth (read only) - The width in pixels of the PDF Page with no scaling applied.
  • formattedHeight (read only) - The height in pixels of the PDF Page with no scaling applied.
  • width (read only) - The width in pixels of the PDF page with scaling applied.
  • height (read only) - The height in pixels of the PDF page with no scaling applied.
  • pageCount (read only) - The total number of pages in the PDF document.
  • totalCharacterCount (read only) - The total number of characters in the PDF document.
  • continuousScrollMode - The continuous scroll mode of the PDF document.
  • scroll - The current scroll of the displayed page as horizontal scroll, vertical scroll.
  • pageGravity - The gravity of the page when the view is larger than the scaled page in either width or height. Currently supported page gravities are:
    • topLeft (default) - top left of page sticks to the top left of the view
      • center - the page is centered in the view
  • hScrollbar - Boolean property to show or hide the horizontal scrollbar
  • vScrollbar - Boolean property to show or hide the vertical scrollbar

The following errors may be thrown by the command:

  • XPDF_ERROR: incorrect number of parameters
  • XPDF_ERROR: can't get property
Tagsexternals