Adobe InDesign CS6 (8.0) Object Model JS: HyperlinkPageDestinations

InDesign CS6

Class

HyperlinkPageDestinations

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

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

ParameterTypeDescription
indexnumberThe index.

HyperlinkPageDestination add ([destination: Page][, withProperties: Object])
Creates a new hyperlink page destination.

ParameterTypeDescription
destinationPageThe document page that the hyperlink points to. (Optional)
withPropertiesObjectInitial values for properties of the new HyperlinkPageDestination (Optional)

HyperlinkPageDestination anyItem ()
Returns any HyperlinkPageDestination in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromHyperlinkPageDestination
Long Integer
String
The HyperlinkPageDestination, index, or name at the beginning of the range. Can accept: HyperlinkPageDestination, Long Integer or String.
toHyperlinkPageDestination
Long Integer
String
The HyperlinkPageDestination, index, or name at the end of the range. Can accept: HyperlinkPageDestination, Long Integer or String.

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

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

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

ParameterTypeDescription
objHyperlinkPageDestinationThe HyperlinkPageDestination whose index comes before the desired HyperlinkPageDestination.

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

ParameterTypeDescription
objHyperlinkPageDestinationThe index of the HyperlinkPageDestination that follows the desired HyperlinkPageDestination.

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

Element of

Document.hyperlinkPageDestinations

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