Adobe InDesign CS6 (8.0) Object Model JS: HyperlinkURLDestinations

InDesign CS6

Class

HyperlinkURLDestinations

 A collection of hyperlink URL 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

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

ParameterTypeDescription
indexnumberThe index.

HyperlinkURLDestination add ([destination: string][, withProperties: Object])
Creates a new hyperlink URL destination.

ParameterTypeDescription
destinationstringThe URL that the hyperlink points to. (Optional)
withPropertiesObjectInitial values for properties of the new HyperlinkURLDestination (Optional)

HyperlinkURLDestination anyItem ()
Returns any HyperlinkURLDestination in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromHyperlinkURLDestination
Long Integer
String
The HyperlinkURLDestination, index, or name at the beginning of the range. Can accept: HyperlinkURLDestination, Long Integer or String.
toHyperlinkURLDestination
Long Integer
String
The HyperlinkURLDestination, index, or name at the end of the range. Can accept: HyperlinkURLDestination, Long Integer or String.

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

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

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

ParameterTypeDescription
objHyperlinkURLDestinationThe HyperlinkURLDestination whose index comes before the desired HyperlinkURLDestination.

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

ParameterTypeDescription
objHyperlinkURLDestinationThe index of the HyperlinkURLDestination that follows the desired HyperlinkURLDestination.

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

Element of

Document.hyperlinkURLDestinations

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