FOM 参照 > Formatting > References > fBookmarkReference interface
fBookmarkReference interface
Macro: tmark
PI: "reference",13
Define a internal bookmark reference.
Call fFormatting.addReference() to create a bookmark during formatting at the position where the reference is added.
BookmarkFitType enumeration
These constants define the intial area to show when a link is followed. This is used in conjunction with the fBookmarkReference.fitMode and fBookmarkReference.marginXXX properties.
The BookmarkFitType enumeration has the following constants of type int.
FIT_PAGE = 1
Used to select the current page.
This is the default value for fBookmarkReference.fitType.
FIT_FRAME = 2
Used to select the current frame within the page, including the frame margins.
FIT_INFRAME = 3
Used to select the current frame within the page, excluding the frame margins.
FIT_COLUMN = 4
Used to select the current column.
FIT_LINE = 5
Used to select the current line.
BookmarkFitMode enumeration
These constants determine how the link target should be shown when the link is followed. This is used in conjunction with the fBookmarkReference.fitType and fBookmarkReference.marginXXX properties.
The BookmarkFitMode enumeration has the following constants of type int.
FIT_ALL = 0
Used to ensure the entire fBookmarkReference.fitType region is visible.
This is the default value for fBookmarkReference.fitMode.
FIT_WIDTH_TOP = 1
Used to ensure the top of the fBookmarkReference.fitType region and its full width is visible.
FIT_WIDTH_CENTER = 2
Used to ensure the center of the fBookmarkReference.fitType region and its full width is visible.
FIT_WIDTH_BOTTOM = 3
Used to ensure the bottom of the fBookmarkReference.fitType region and its full width is visible.
FIT_HEIGHT_LEFT = 4
Used to ensure the left of the fBookmarkReference.fitType region and its full height is visible.
FIT_HEIGHT_CENTER = 5
Used to ensure the left of the fBookmarkReference.fitType region and its full height is visible.
FIT_HEIGHT_RIGHT = 6
Used to ensure the left of the fBookmarkReference.fitType region and its full height is visible.
FIT_NONE = 7
Used to cause no change to the zoom level of the viewable area.
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
expanded attribute
This determines if the bookmark should be expanded in the bookmark pane if added to the PDF.
expanded
Access
read-write
Returns
boolean
fitMode attribute
The mode to use when fitting the selected type. See fBookmarkReference.BookmarkFitMode.
fitMode
Access
read-write
Returns
int
fitType attribute
The type to use when fitting with the selected fitMode. See fBookmarkReference.BookmarkFitType.
fitType
Access
read-write
Returns
int
level attribute
This determines which level of the PDF list the bookmark should be placed in.
This is used when fBookmarkReference.listInPDF is true. This property is ignored if fBookmarkReference.parent is set.
level
Access
read-write
Returns
int
listInPDF attribute
This determines if the bookmark is to be added to PDF's bookmark list.
listInPDF
Access
read-write
Returns
boolean
marginBottom attribute
This determines the bottom margin to apply to the fBookmarkReference.fitMode.
marginBottom
Access
read-write
Returns
fLength
marginLeft attribute
This determines the left margin to apply to the fBookmarkReference.fitMode.
marginLeft
Access
read-write
Returns
fLength
marginRight attribute
This determines the right margin to apply to the fBookmarkReference.fitMode.
marginRight
Access
read-write
Returns
fLength
marginTop attribute
This determines the top margin to apply to the fBookmarkReference.fitMode.
marginTop
Access
read-write
Returns
fLength
name attribute
The name of the bookmark tag to create for the bookmark.
name
Access
read-write
Returns
String
parent attribute
If fBookmarkReference.listInPDF is true, this bookmark will be created as a child of the bookmark with this name. If this property is set, fBookmarkReference.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
fBookmarkReference method
Constructor for an fBookmarkReference, used to create a fBookmarkReferenceObject.
fBookmarkReference name description fitType fitMode marginLeft marginRight marginTop marginBottom listInPDF level expanded
Parameters
String name
[optional] The name of the bookmark.
String description
[optional] The description to use for the bookmark.
int fitType
[optional] The fit type to use for the bookmark. See fBookmarkReference.BookmarkFitType.
int fitMode
[optional] The fit mode to use for the bookmark. See fBookmarkReference.BookmarkFitMode.
fLength marginLeft
[optional] This determines the left margin to apply to the fBookmarkReference.fitMode.
fLength marginRight
[optional] This determines the right margin to apply to the fBookmarkReference.fitMode.
fLength marginTop
[optional] This determines the top margin to apply to the fBookmarkReference.fitMode.
fLength marginBottom
[optional] This determines the bottom margin to apply to the fBookmarkReference.fitMode.
boolean listInPDF
[optional] Should the bookmark be listed in the PDF bookmark list.
int level
[optional] The level within the PDF bookmark list to place the bookmark.
boolean expanded
[optional] If true, the bookmark will be expanded in the PDF bookmark list.
Returns
fBookmarkReference. A new object of class fBookmarkReference.
readResolve method
Return the object corresponding to the given serialized representation.
readResolve obj
Parameters
Object obj
The serialized representation.
Returns
fBookmarkReference. The object corresponding to the serialized representation.
toString method
Return the PI compatible string for the bookmark reference.
toString
Parameters
None
Returns
String. A PI compatible representation of this bookmark reference as a string.
Parent topic 
References
Related information 
fLength interface
これは役に立ちましたか?