HyperlinkPageDestination
A hyperlink destination that is a document page.
Instance
Read Only
Boolean hidden
If true, the hyperlink is hidden.
Read Only
Number id
The unique ID of the HyperlinkPageDestination.
Read Only
Boolean isValid
Returns true if the object specifier resolves to valid objects.
Read Only
Document parent
The parent of the HyperlinkPageDestination (a Document).
Read Only
Number index
The index of the HyperlinkPageDestination within its containing object.
Read Only
Events events
A collection of events.
Read Only
EventListeners eventListeners
A collection of event listeners.
String name
The name of the HyperlinkPageDestination.
Boolean nameManually
If true or unspecified, allows a custom destination name; also does not update the name when the destination is moved to a different page. If false, uses the page number as the page destination name and makes the name property read-only for the destination object; also updates the name when the destination is moved to a different page.
Page destinationPage
The page that the hyperlink points to.
HyperlinkDestinationPageSetting viewSetting
The destination page size when the page is reached by clicking the hyperlink.
Mixed viewBounds
The view rectangle, specified in the format [y1, x1, y2, x2]. Note: Valid only when view setting is fixed. Can return: Ordered array containing top:Unit, left:Unit, bottom:Unit, right:Unit.
Number viewPercentage
The zoom percentage. (Range: 5 to 4000) Note: Valid only when view setting is fixed.
String label
A property that can be set to any string.
Object properties
A property that allows setting of several properties at the same time.
Methods
remove()
Deletes the HyperlinkPageDestination.
showDestination()
Jumps to the hyperlink destination.
insertLabel( String key, String value )
Sets the label to the value associated with the specified key.
Parameters
Type Name Description
String extractLabel( String key )
Gets the label value associated with the specified key.
Parameters
Type Name Description
String toSource()
Generates a string which, if executed, will return the HyperlinkPageDestination.
HyperlinkPageDestination getElements()
Resolves the object specifier, creating an array of object references.
String toSpecifier()
Retrieves the object specifier.
EventListener addEventListener( String eventType, Mixed handler, Boolean captures )
Adds an event listener.
Parameters
Type Name Description
Boolean removeEventListener( String eventType, Mixed handler, Boolean captures )
Removes the event listener.
Parameters
Type Name Description