Type | widget |
Dictionary | widget.pdf |
Library | |
Associations | com.livecode.widget.pdf |
Summary | A PDF widget |
Edition | Pro |
OS | mac, windows, linux, ios, android |
Platforms | desktop, server, mobile |
Description | This widget uses the PDFium library to render PDF pages
|
Type | Name | Summary | Syntax |
---|---|---|---|
message | imageClicked | Sent when the user clicks on an image | imageClicked |
- - - | linkClicked | Sent when the user clicks on a link annotation | linkClicked <pAction> |
- - - | pageChanged | Sent when the displayed page is changed by user action | pageChanged <pPage>, <pPreviousPage> |
- - - | scrollbarDrag | Sent when the scroll is changed by user action | scrollbarDrag <hScroll>, <vScroll> |
- - - | selectionChanged | Sent when the user selects text. | selectionChanged <pRange> |
- - - | zoomChanged | Sent when the zoom is changed by user action | zoomChanged <pZoom> |
property | autoHilight | Allow text selection changes via user interaction | : get the autoHilight of <widget> set the autoHilight of <widget> to {true | false} |
- - - | borderWidth | The width of the border to draw | get the borderWidth of <widget> set the borderWidth of <widget> to <pixels> |
- - - | clickedImage | Get the image data of the image that was clicked on | : get the clickedImage of <widget> |
- - - | currentDestination | Go to a destination | get the currentDestination of <widget> set the currentDestination of <widget> to { <destinationArray> | <destinationName> } |
- - - | currentPage | Set the visible page of the PDF document | get the currentPage of <widget> set the currentPage of <widget> to <pageNumber> |
- - - | documentBookmarks | Get an array detailing the bookmarks in the document | get the documentBookmarks of <widget> |
- - - | documentMetadata | Get an array detailing the metadata of the document | get the documentMetadata of <widget> |
- - - | documentNamedDestinations | Get an array detailing the named destinations in the document | get the documentNamedDestinations of <widget> |
- - - | documentOpenAction | Get the action that should be run when opening the document | get the documentOpenAction of <widget> |
- - - | documentPages | Get an array detailing the pages in the document | get the documentPages of <widget> |
- - - | documentViewerPreferences | Get an array detailing the viewer preferences of the document | get the documentViewerPreferences of <widget> |
- - - | drawAnnotations | Whether annotations are drawn on the PDF | get the drawAnnotations of <widget> set the drawAnnotations of <widget> to {true | false} |
- - - | fileData | The binary file data of a PDF document | get the fileData of <widget> set the fileData of <widget> to <fileData> |
- - - | fileName | The file path to a PDF document | get the fileName of <widget> set the fileName of <widget> to <fileData> |
- - - | flipPages | Use a page flip animation instead of slide | get the flipPages of <widget> set the flipPages of <widget> to { true | false } |
- - - | formattedRect | The formatted rect of the widget | get the formattedRect of <widget> |
- - - | hilitedRange | Get and set the currently selected range of text. | : get the hilitedRange of <widget> set the hilitedRange of <widget> to <pRange> |
- - - | hilitedRangeText | Get the currently selected text. | : get the hilitedRangeText of <widget> |
- - - | hScroll | Set the horizontal scroll of the widget | get the hScroll of <widget> set the hScroll of <widget> to <pixels> |
- - - | hScrollbar | Whether to draw the horizontal scrollbar | get the hScrollbar of <widget> set the hScrollbar of <widget> to {true | false} |
- - - | linkStyles | An array of styles to apply to links | get the linkStyles of <widget> set the linkStyles of <widget> to <array> |
- - - | lockPage | Locks page changes via user interaction | : get the lockPage of <widget> set the lockPage of <widget> to {true | false} |
- - - | lockScroll | Locks scrolling via user interaction | : get the lockScroll of <widget> set the lockScroll of <widget> to {true | false} |
- - - | lockZoom | Locks zoom via user interaction | : get the lockZoom of <widget> Syntax: set the lockZoom of <widget> to {true | false} |
- - - | numberOfPages | The number of pages in the loaded document | get the numberOfPages of <widget> |
- - - | opaque | Whether the background of the widget is filled | get the opaque of <widget> set the opaque of <widget> to {true | false} |
- - - | pageBackColor | The color of the page back during a page flip | get the pageBackColor of <widget> set the pageBackColor of <widget> to <color> |
- - - | pageBorderColor | The color of the page border | get the pageBorderColor of <widget> set the pageBorderColor of <widget> to <color> |
- - - | pageBorderWidth | The width of the border to draw around each page | get the pageBorderWidth of <widget> set the pageBorderWidth of <widget> to <pixels> |
- - - | pageDisplay | The mode of page display | get the pageDisplay of <widget> set the pageDisplay of <widget> to <pageDisplay> |
- - - | pageGravity | The gravity of the page | get the pageGravity of <widget> set the pageGravity of <widget> to { "topLeft", "center" } |
- - - | pageLocation | The x,y location of the current page relative to the card | get the pageLocation of <widget> set the pageLocation of <widget> to <location> |
- - - | pagePadding | The width of the padding around each page | get the pagePadding of <widget> set the pagePadding of <widget> to <pixels> |
- - - | pageRect | The left,top,right,bottom rect of the current page relative to the card | get the pageRect of <widget> set the pageRect of <widget> to <rect> |
- - - | password | The password used to read password protected PDF document | get the password of <widget> set the password of <widget> to <password> |
- - - | scroll | Set the vertical scroll of the widget | get the scroll of <widget> set the scroll of <widget> to <pixels> |
- - - | showBorder | Whether to draw the border | get the showBorder of <widget> set the showBorder of <widget> to {true | false} |
- - - | showPageBorder | Whether to draw the page border | get the showPageBorder of <widget> set the showPageBorder of <widget> to {true | false} |
- - - | threeD | Whether to draw the border three D | get the threeD of <widget> set the threeD of <widget> to {true | false} |
- - - | vScrollbar | Whether to draw the vertial scrollbar | get the vScrollbar of <widget> set the vScrollbar of <widget> to {true | false} |
- - - | zoom | The zoom of the PDF | get the zoom of <widget> set the zoom of <widget> to <zoom> |
widget | A PDF widget | get the zoom of <widget> set the zoom of <widget> to <zoom> |