Adobe InDesign CS5.5 (7.5) Object Model JS: Hyperlinks

InDesign CS5.5

Class

Hyperlinks

 A collection of hyperlinks.

See also Hyperlink.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

Hyperlink [] (index: number)
Returns the Hyperlink with the specified index.

ParameterTypeDescription
indexnumberThe index.

Hyperlink add (hyperlinkSource: varies[, hyperlinkDestination: varies][, withProperties: Object])
Creates a new hyperlink.

ParameterTypeDescription
hyperlinkSourceCrossReferenceSource
HyperlinkPageItemSource
HyperlinkTextSource
The hyperlinked object. Can accept: HyperlinkPageItemSource, HyperlinkTextSource or CrossReferenceSource.
hyperlinkDestinationdataLinkClassId:Long Integer
destinationUid:Long Integer
directoryId:Long Integer
HyperlinkExternalPageDestination
HyperlinkPageDestination
HyperlinkTextDestination
HyperlinkURLDestination
Ordered array containing fileName:String
ParagraphDestination
volumn:String
The destination that the hyperlink points to. Can accept: Ordered array containing fileName:String, volumn:String, directoryId:Long Integer, dataLinkClassId:Long Integer, destinationUid:Long Integer, HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination, HyperlinkURLDestination or ParagraphDestination. (Optional)
withPropertiesObjectInitial values for properties of the new Hyperlink (Optional)

Hyperlink anyItem ()
Returns any Hyperlink in the collection.

number count ()
Displays the number of elements in the Hyperlink.

Array of Hyperlink everyItem ()
Returns every Hyperlink in the collection.

Hyperlink firstItem ()
Returns the first Hyperlink in the collection.

Hyperlink item (index: varies)
Returns the Hyperlink with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

Hyperlink itemByID (id: number)
Returns the Hyperlink with the specified ID.

ParameterTypeDescription
idnumberThe ID.

Hyperlink itemByName (name: string)
Returns the Hyperlink with the specified name.

ParameterTypeDescription
namestringThe name.

Array of Hyperlink itemByRange (from: varies, to: varies)
Returns the Hyperlinks within the specified range.

ParameterTypeDescription
fromHyperlink
Long Integer
String
The Hyperlink, index, or name at the beginning of the range. Can accept: Hyperlink, Long Integer or String.
toHyperlink
Long Integer
String
The Hyperlink, index, or name at the end of the range. Can accept: Hyperlink, Long Integer or String.

Hyperlink lastItem ()
Returns the last Hyperlink in the collection.

Hyperlink middleItem ()
Returns the middle Hyperlink in the collection.

Hyperlink nextItem (obj: Hyperlink)
Returns the Hyperlink whose index follows the specified Hyperlink in the collection.

ParameterTypeDescription
objHyperlinkThe Hyperlink whose index comes before the desired Hyperlink.

Hyperlink previousItem (obj: Hyperlink)
Returns the Hyperlink with the index previous to the specified index.

ParameterTypeDescription
objHyperlinkThe index of the Hyperlink that follows the desired Hyperlink.

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

Element of

Document.hyperlinks

Jongware, 28-Apr-2012 v3.0.3iContents :: Index