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

InDesign Server CS5

Class

HyperlinkURLDestination

 A hyperlink destination that is a URL.

QuickLinks

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

Hierarchy

Document
HyperlinkURLDestination
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
destinationURLstring r/wThe URL the hyperlink 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 HyperlinkURLDestination.
indexnumber readonlyThe index of the HyperlinkURLDestination 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 r/wThe name of the HyperlinkURLDestination.
parentDocument readonlyThe parent of the HyperlinkURLDestination (a Document).
propertiesObject r/wA property that allows setting of several properties at the same time.

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

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Hyperlink.destination

Used in:

HyperlinkURLDestination HyperlinkURLDestinations.nextItem (obj: HyperlinkURLDestination)

HyperlinkURLDestination HyperlinkURLDestinations.previousItem (obj: HyperlinkURLDestination)

Return

Array of HyperlinkURLDestination HyperlinkURLDestination.getElements ()

HyperlinkURLDestination HyperlinkURLDestinations.[] (index: number)

HyperlinkURLDestination HyperlinkURLDestinations.add ([destination: string][, withProperties: Object])

HyperlinkURLDestination HyperlinkURLDestinations.anyItem ()

Array of HyperlinkURLDestination HyperlinkURLDestinations.everyItem ()

HyperlinkURLDestination HyperlinkURLDestinations.firstItem ()

HyperlinkURLDestination HyperlinkURLDestinations.item (index: varies)

HyperlinkURLDestination HyperlinkURLDestinations.itemByID (id: number)

HyperlinkURLDestination HyperlinkURLDestinations.itemByName (name: string)

Array of HyperlinkURLDestination HyperlinkURLDestinations.itemByRange (from: varies, to: varies)

HyperlinkURLDestination HyperlinkURLDestinations.lastItem ()

HyperlinkURLDestination HyperlinkURLDestinations.middleItem ()

HyperlinkURLDestination HyperlinkURLDestinations.nextItem (obj: HyperlinkURLDestination)

HyperlinkURLDestination HyperlinkURLDestinations.previousItem (obj: HyperlinkURLDestination)

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