FOM Reference > Content > Tags > fBookmark interface
  
fBookmark interface
Macro: tpmkset
This class represents the bookmark tag created using fFormatting.addReference() or fContent.createBookmark().
BookmarkTypes enumeration
These constants define the type of bookmark to created from the reference.
The BookmarkTypes enumeration has the following constants of type int.
TYPE_INTERNAL = 0
Used to indicate an internal document reference to the page and postion where the reference is added.
TYPE_EXTERNAL = 1
Used to indicate a referece to an external document.
TYPE_URI = 2
Used to indicate a reference to a remote URI.
TYPE_PDF_3DVIEW = 3
Used to indicate a reference to a 3D View in the PDF.
TYPE_PDF_MEDIA = 4
Used to indicate a reference to a Media object in the PDF.
TYPE_PDF_JAVASCRIPT = 5
Used to indicate a JavaScript function to run.
TYPE_PDF_ACTION = 6
Used to indicate a PDF Action to run.
BookmarkFitMode enumeration
These constants determine how the link target will be shown when the link is followed.
The BookmarkFitMode enumeration has the following constants of type int.
FIT_ALL = 0
Used to ensure the entire region is visible.
FIT_WIDTH_TOP = 1
Used to ensure the top of the region and its full width is visible.
FIT_WIDTH_CENTER = 2
Used to ensure the center of the region and its full width is visible.
FIT_WIDTH_BOTTOM = 3
Used to ensure the bottom of the region and its full width is visible.
FIT_HEIGHT_LEFT = 4
Used to ensure the left of the region and its full height is visible.
FIT_HEIGHT_CENTER = 5
Used to ensure the left of the region and its full height is visible.
FIT_HEIGHT_RIGHT = 6
Used to ensure the left of the region and its full height is visible.
FIT_NONE = 7
Used to cause no change to the zoom level of the viewable area.
bookmarkType attribute
The type of bookmark, see fBookmark.BookmarkTypes.
bookmarkType
Access
read-write
Returns
int
description attribute
The description for the bookmark. If the bookmark is added to the PDF bookmark list, this description will be used in the list. If empty, the name will be used.
description
Access
read-write
Returns
String
fitMode attribute
The mode to use when fitting the selected type. See fBookmark.BookmarkFitMode.
This is not relevant when type is set to fBookmark.TYPE_URI.
fitMode
Access
read-write
Returns
int
level attribute
This indicates which level of the PDF list the bookmark should be placed in.
This is relevant when fBookmark.listInPDF is true. This property is ignored if fBookmark.parent is set.
level
Access
read-write
Returns
int
listInPDF attribute
This indicates if the bookmark will be added to PDF's bookmark list.
This is not relevant when type is set to fBookmark.TYPE_URI.
listInPDF
Access
read-write
Returns
boolean
outlinePage attribute
This indicates the page on which the bookmark will appear within the bookmark list.
This is only relevant when type is set to fBookmark.TYPE_EXTERNAL.
outlinePage
Access
read-write
Returns
int
parent attribute
If fBookmark.listInPDF is true, this bookmark will be created as a child of the bookmark with this name. If this property is set, fBookmark.level will be ignored.
parent
Access
read-write
Returns
String
pdfName attribute
The name to use when creating this bookmark in the PDF. If this is not set, then the name of the bookmark tag will be used instead.
pdfName
Access
read-write
Returns
String
remoteFile attribute
The filename used when using a bookmark to another document or a URI.
This is not relevant when type is set to fBookmark.TYPE_INTERNAL.
If type is set to fBookmark.TYPE_PDF_3DVIEW or fBookmark.TYPE_PDF_MEDIA, this is the name of the PDF object to link to. If the type is set to fBookmark-TYPE_PDF_JAVASCRIPT, this is the JavaScript to run. If the type is set to fBookmark-TYPE_PDF_ACTION, this is the name of the fPDFAction tag to run.
remoteFile
Access
read-write
Returns
String
remoteName attribute
The bookmark name used when using a bookmark in another document.
This is only relevant when type is set to fBookmark.TYPE_EXTERNAL.
If type is set to fBookmark.TYPE_PDF_3DVIEW, this is the name of the view to select in the object specified by fBookmark-remoteName. If type is set to fBookmark.TYPE_PDF_MEDIA, this is the name of the function to call in the Flash wrapper for the Media object.
remoteName
Access
read-write
Returns
String
targetBottom attribute
This indicates the bottom position of the target on the target page.
This is only relevant when type is set to fBookmark.TYPE_INTERNAL.
targetBottom
Access
read-write
Returns
fLength
targetLeft attribute
This indicates the left position of the target on the target page.
This is only relevant when type is set to fBookmark.TYPE_INTERNAL.
targetLeft
Access
read-write
Returns
fLength
targetPage attribute
This indicates the page number the bookmark reference is on.
This is only relevant when type is set to fBookmark.TYPE_INTERNAL.
targetPage
Access
read-write
Returns
int
targetRight attribute
This indicates the right position of the target on the target page.
This is only relevant when type is set to fBookmark.TYPE_INTERNAL.
targetRight
Access
read-write
Returns
fLength
targetTop attribute
This indicates the top position of the target on the target page.
This is only relevant when type is set to fBookmark.TYPE_INTERNAL.
targetTop
Access
read-write
Returns
fLength