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:

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

Objects:

Boolean, EventListeners, Events, File, 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	File	read/write	The path to the document that the hyperlink destination points to.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
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.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
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	Orderedarraycontainingtop:Unit Bottom:Unit Left:Unit Right:Unit	read/write	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.
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

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	File JavaScriptFunction	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

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

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
eventType	String	The registered event type.
handler	File JavaScriptFunction	The registered event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)