Adobe InDesign CS (3.0) Object Model JS: HyperlinkURLDestination

InDesign CS

Class

HyperlinkURLDestination

 A hyperlink destination that is a URL.

QuickLinks

extractLabel, insertLabel, remove, showDestination

Hierarchy

Document
HyperlinkURLDestination

Properties

PropertyTypeAccessDescription
destinationURLstring r/wThe URL the hyperlink points to.
hiddenbool readonlyIf true, the hyperlink is hidden.
idnumber readonlyThe unique ID of the HyperlinkURLDestination.
indexnumber readonlyThe index of the HyperlinkURLDestination within its containing object.
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

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

ParameterTypeDescription
keystringThe key.

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.

void showDestination ()
Jumps to the hyperlink destination.

Element of

Bookmark.destination

Hyperlink.destination

Used in:

Bookmark Bookmarks.add (destination: any[, withProperties: Object])

Hyperlink Hyperlinks.add (hyperlinkSource: any[, hyperlinkDestination: any][, withProperties: Object])

Return

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

Jongware, 27-Jun-2010 v3.0.3dContents :: Index