documentBookmarks

Typeproperty
Dictionarywidget.pdf
LibraryPDF
Syntax
get the documentBookmarks of <widget>
Associationscom.livecode.widget.pdf
Summary

Get an array detailing the bookmarks in the document

EditionPro
OSmac, windows, linux, ios, android
Platformsdesktop, server, mobile
Description

If the document has bookmarks the documentBookmarks property will return a numerically indexed array where each element may have the following keys:

  • "title": if a bookmark title is set
  • "type": one of goto, remotegoto, launch, uri or unsupported
  • "filename": remotegoto or launch types
  • "uripath": uri type only
  • "page": goto type only
  • "mode": goto type only. The value will be one of:"XYZ", "Fit", "FitH", "FitV", "FitR", "FitB", "FitBH", "FitBV"
  • "left": goto type and XYZ, FitV, FitBV & FitR modes
  • "top": goto type and XYZ, FitH, FitBH & FitR modes
  • "right": goto type and FitR mode
  • "bottom": goto type and FitR mode
  • "zoom": goto type and XYZ mode
  • "children": a numerically indexed array of child bookmarks