HyperlinkPageDestination

A hyperlink destination that is a document page.

Go to Property Listing | Method Listing

Methods:

extractLabel, getElements, insertLabel, remove, showDestination, toSource, toSpecifier

Objects:

Boolean, HyperlinkDestinationPageSetting, Number, Object, Page, String

Property Listing

Property	Type	Access	Description
destinationPage	Page	read/write	The page that the hyperlink points to.
hidden	Boolean	readonly	If true, the hyperlink is hidden.
id	Number	readonly	The unique ID of the HyperlinkPageDestination.
index	Number	readonly	The index of the HyperlinkPageDestination within its containing object.
label	String	read/write	A property that can be set to any string.
name	String	read/write	The name of the HyperlinkPageDestination.
nameManually	Boolean	read/write	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.
parent	Document	readonly	The parent of the HyperlinkPageDestination (a Document).
properties	Object	read/write	A property that allows setting of several properties at the same time.
viewBounds	Array of Number Array of String	read/write	The view rectangle, specified in the format [y1, x1, y2, x2]. Note: Valid only when view setting is fixed.
viewPercentage	Number (range 5 - 4000)	read/write	The zoom percentage. (Range: 5 to 4000) Note: Valid only when view setting is fixed.
viewSetting	HyperlinkDestinationPageSetting HyperlinkDestinationPageSetting.FIT_HEIGHT HyperlinkDestinationPageSetting.FIT_VIEW HyperlinkDestinationPageSetting.FIT_VISIBLE HyperlinkDestinationPageSetting.FIT_WIDTH HyperlinkDestinationPageSetting.FIT_WINDOW HyperlinkDestinationPageSetting.FIXED HyperlinkDestinationPageSetting.INHERIT_ZOOM	read/write	The destination page size when the page is reached by clicking the hyperlink.

Method Listing

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

HyperlinkPageDestination getElements ()

Resolves the object specifier, creating an array of object references.

undefined insertLabel (key:String, value:String)

Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	String	The key.
value	String	The value.

undefined remove ()

Deletes the HyperlinkPageDestination.

undefined showDestination ()

Jumps to the hyperlink destination.

String toSource ()

Generates a string which, if executed, will return the HyperlinkPageDestination.

String toSpecifier ()

Retrieves the object specifier.

Object of

Bookmark.destination

Hyperlink.destination