Class

HyperlinkPageDestination

A hyperlink destination that is a document page.

QuickLinks

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

Hierarchy

Document

HyperlinkPageDestination

Event | EventListener | MutationEvent

Properties

Property	Type	Access	Description
destinationPage	Page	r/w	The page that the hyperlink points to.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
hidden	bool	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.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
label	string	r/w	A property that can be set to any string.
name	string	r/w	The name of the HyperlinkPageDestination.
nameManually	bool	r/w	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	r/w	A property that allows setting of several properties at the same time.
viewBounds	bottom:Unit left:Unit Ordered array containing top:Unit right:Unit	r/w	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)	r/w	The zoom percentage. (Range: 5 to 4000) Note: Valid only when view setting is fixed.
viewSetting	HyperlinkDestinationPageSetting: HyperlinkDestinationPageSetting.FIXED HyperlinkDestinationPageSetting.FIT_VIEW HyperlinkDestinationPageSetting.FIT_WINDOW HyperlinkDestinationPageSetting.FIT_WIDTH HyperlinkDestinationPageSetting.FIT_HEIGHT HyperlinkDestinationPageSetting.FIT_VISIBLE HyperlinkDestinationPageSetting.INHERIT_ZOOM	r/w	The destination page size when the page is reached by clicking the hyperlink.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	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.

Array of HyperlinkPageDestination getElements ()
Resolves the object specifier, creating an array of object references.

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

void remove ()
Deletes the HyperlinkPageDestination.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

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

void showDestination ()
Jumps to the hyperlink destination.

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Bookmark.destination

GotoAnchorBehavior.anchorItem

Hyperlink.destination

Used in:

HyperlinkPageDestination HyperlinkPageDestinations.nextItem (obj: HyperlinkPageDestination)

HyperlinkPageDestination HyperlinkPageDestinations.previousItem (obj: HyperlinkPageDestination)

Return

Array of HyperlinkPageDestination HyperlinkPageDestination.getElements ()

HyperlinkPageDestination HyperlinkPageDestinations.[] (index: number)

HyperlinkPageDestination HyperlinkPageDestinations.add ([destination: Page][, withProperties: Object])

HyperlinkPageDestination HyperlinkPageDestinations.anyItem ()

Array of HyperlinkPageDestination HyperlinkPageDestinations.everyItem ()

HyperlinkPageDestination HyperlinkPageDestinations.firstItem ()

HyperlinkPageDestination HyperlinkPageDestinations.item (index: varies)

HyperlinkPageDestination HyperlinkPageDestinations.itemByID (id: number)

HyperlinkPageDestination HyperlinkPageDestinations.itemByName (name: string)

Array of HyperlinkPageDestination HyperlinkPageDestinations.itemByRange (from: varies, to: varies)

HyperlinkPageDestination HyperlinkPageDestinations.lastItem ()

HyperlinkPageDestination HyperlinkPageDestinations.middleItem ()

HyperlinkPageDestination HyperlinkPageDestinations.nextItem (obj: HyperlinkPageDestination)

HyperlinkPageDestination HyperlinkPageDestinations.previousItem (obj: HyperlinkPageDestination)

Jongware, 28-Apr-2012 v3.0.3i

Contents :: Index