HyperlinkPageDestination

A hyperlink page destination.

HyperlinkPageDestination Properties

Property Type Access Description
destinationPage Page r/w The page this destination points to.
hidden Boolean read Is this object hidden in the UI.
id Long read A unique number identifying the object.
index Long read Index of the object within its parent object.
label String r/w A label that can be set to any string.
name String r/w The name of the object.
nameManually Boolean r/w Use a user supplied name for the destination.
parent Object read The parent of the object.
properties An array of property names and values r/w Property that allows setting of several properties at the same time.
viewBounds Array of 4 Units r/w The view rectangle (ignored unless view setting is fixed).
viewPercentage Real (5 – 4000) r/w The zoom percentage (ignored unless view setting is fixed).
viewSetting HyperlinkDestinationPageSetting enumeration r/w The view setting for the target page.

HyperlinkPageDestination Methods

Method Returns Description
extractLabel String Gets the content of the label associated with the specified key (name).
getElements Array of Objects Resolve the object specifier.
insertLabel Nothing Sets the content of the label associated with the specified key (name), creating the label if it does not already exist.
remove Nothing Delete the object.
showDestination Nothing Go to Hyperlink destination.
toSource String Generate JavaScript source that, if executed, will return the specified objects.
toSpecifier String Retrieve the object specifier.

Leave a Comment

Previous post:

Next post: