Adobe InDesign CS4 (6.0) Object Model JS: HyperlinkURLDestination

InDesign CS4

Class

HyperlinkURLDestination

 A hyperlink destination that is a URL.

QuickLinks

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

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

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.

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:

array of HyperlinkURLDestination HyperlinkURLDestinations.itemByRange (from: any, to: any)

HyperlinkURLDestination HyperlinkURLDestinations.nextItem (obj: HyperlinkURLDestination)

HyperlinkURLDestination HyperlinkURLDestinations.previousItem (obj: HyperlinkURLDestination)

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

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: any)

HyperlinkURLDestination HyperlinkURLDestinations.itemByID (id: number)

HyperlinkURLDestination HyperlinkURLDestinations.itemByName (name: string)

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

HyperlinkURLDestination HyperlinkURLDestinations.lastItem ()

HyperlinkURLDestination HyperlinkURLDestinations.middleItem ()

HyperlinkURLDestination HyperlinkURLDestinations.nextItem (obj: HyperlinkURLDestination)

HyperlinkURLDestination HyperlinkURLDestinations.previousItem (obj: HyperlinkURLDestination)

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