Adobe InDesign CS5 Server (7.0) Object Model JS: HyperlinkExternalPageDestination

InDesign Server CS5

Class

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.

QuickLinks

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

Hierarchy

Document
HyperlinkExternalPageDestination
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
destinationPageIndexnumber (range: 1 - 9999) r/wThe index of the page that the hyperlink destination points to. Note: Valid only when hyperlink destination is an external page.
documentPathFile r/wThe path to the document that the hyperlink destination points to.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
hiddenbool readonlyIf true, the hyperlink is hidden.
idnumber readonlyThe unique ID of the HyperlinkExternalPageDestination.
indexnumber readonlyThe index of the HyperlinkExternalPageDestination within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
namestring readonlyThe name of the HyperlinkExternalPageDestination.
parentDocument readonlyThe parent of the HyperlinkExternalPageDestination (a Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
viewBoundsbottom:Unit
left:Unit
Ordered array containing top:Unit
right:Unit
r/wThe 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.
viewPercentagenumber (range: 5 - 4000) r/wThe zoom percentage. (Range: 5 to 4000) Note: Valid only when view setting is fixed.
viewSettingHyperlinkDestinationPageSetting:
HyperlinkDestinationPageSetting.FIXED
HyperlinkDestinationPageSetting.FIT_VIEW
HyperlinkDestinationPageSetting.FIT_WINDOW
HyperlinkDestinationPageSetting.FIT_WIDTH
HyperlinkDestinationPageSetting.FIT_HEIGHT
HyperlinkDestinationPageSetting.FIT_VISIBLE
HyperlinkDestinationPageSetting.INHERIT_ZOOM
r/wThe 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.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

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

ParameterTypeDescription
keystringThe key.
valuestringThe value.

void remove ()
Deletes the HyperlinkExternalPageDestination.

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

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

void showDestination ()
Jumps to the hyperlink destination.

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Bookmark.destination

Hyperlink.destination

Used in:

HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.nextItem (obj: HyperlinkExternalPageDestination)

HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.previousItem (obj: HyperlinkExternalPageDestination)

Return

Array of HyperlinkExternalPageDestination HyperlinkExternalPageDestination.getElements ()

HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.[] (index: number)

HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.add ([destination: Page][, withProperties: Object])

HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.anyItem ()

Array of HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.everyItem ()

HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.firstItem ()

HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.item (index: varies)

HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.itemByID (id: number)

HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.itemByName (name: string)

Array of HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.itemByRange (from: varies, to: varies)

HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.lastItem ()

HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.middleItem ()

HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.nextItem (obj: HyperlinkExternalPageDestination)

HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.previousItem (obj: HyperlinkExternalPageDestination)

Jongware, 23-Mar-2011 v3.0.3dContents :: Index