Adobe InDesign CS2 (4.0) Object Model JS: HyperlinkTextDestinations

InDesign CS2

Class

HyperlinkTextDestinations

 A collection of hyperlink text destinations.

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

HyperlinkTextDestination add (destination: Text[, withProperties: Object])
Creates a new hyperlink text destination.

ParameterTypeDescription
destinationTextThe text or insertion point location that the hyperlink points to.
withPropertiesObjectInitial values for properties of the new HyperlinkTextDestination (Optional)

HyperlinkTextDestination anyItem ()
Returns any HyperlinkTextDestination in the collection.

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

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

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

HyperlinkTextDestination item (index: any)
Returns the HyperlinkTextDestination with the specified index or name.

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

Array of HyperlinkTextDestination itemByRange (from: any, to: any)
Returns the HyperlinkTextDestinations within the specified range.

ParameterTypeDescription
fromHyperlinkTextDestination
Long
String
The HyperlinkTextDestination, index, or name at the beginning of the range. Can accept: HyperlinkTextDestination, Long or String.
toHyperlinkTextDestination
Long
String
The HyperlinkTextDestination, index, or name at the end of the range. Can accept: HyperlinkTextDestination, Long or String.

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

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

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

ParameterTypeDescription
objHyperlinkTextDestinationThe HyperlinkTextDestination whose index comes before the desired HyperlinkTextDestination.

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

ParameterTypeDescription
objHyperlinkTextDestinationThe index of the HyperlinkTextDestination that follows the desired HyperlinkTextDestination.

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

Element of

Document.hyperlinkTextDestinations

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