HyperlinkExternalPageDestination

A hyperlink destination that is a page in a document other than the document that contains the hyperlink source. For information on hyperlink sources, hyperlink page item source or hyperlink text source.

Go to Property Listing | Method Listing

Methods:

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

Objects:

Boolean, HyperlinkDestinationPageSetting, Number, Object, String

Property Listing

Property	Type	Access	Description
destinationPageIndex	Number (range 1 - 9999)	read/write	The index of the page that the hyperlink destination points to. Note: Valid only when hyperlink destination is an external page.
documentPath	String	read/write	The file path to the document that contains the page that the hyperlink jumps to. Note: Valid only when hyperlink destination is an external page. For information, see hyperlink desination and hyperlink external page destination.
hidden	Boolean	readonly	If true, the hyperlink is hidden.
id	Number	readonly	The unique ID of the HyperlinkExternalPageDestination.
index	Number	readonly	The index of the HyperlinkExternalPageDestination within its containing object.
label	String	read/write	A property that can be set to any string.
name	String	readonly	The name of the HyperlinkExternalPageDestination.
parent	Document	readonly	The parent of the HyperlinkExternalPageDestination (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.

Object 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 HyperlinkExternalPageDestination.

undefined showDestination ()

Jumps to the hyperlink destination.

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Bookmark.destination

Hyperlink.destination

Return

HyperlinkExternalPageDestinations.add()

HyperlinkExternalPageDestinations.anyItem()

HyperlinkExternalPageDestinations.everyItem()

HyperlinkExternalPageDestinations.nextItem()

HyperlinkExternalPageDestinations.previousItem()

HyperlinkExternalPageDestinations.itemByID()

HyperlinkExternalPageDestinations.item()

HyperlinkExternalPageDestinations.itemByName()

HyperlinkExternalPageDestinations.itemByRange()

HyperlinkExternalPageDestinations.firstItem()

HyperlinkExternalPageDestinations.lastItem()

HyperlinkExternalPageDestinations.middleItem()