Adobe InDesign CS5 Server (7.0) Object Model JS: HyperlinkExternalPageDestinations

InDesign Server CS5

Class

HyperlinkExternalPageDestinations

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

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

ParameterTypeDescription
indexnumberThe index.

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

ParameterTypeDescription
destinationPageThe destination page. (Optional)
withPropertiesObjectInitial values for properties of the new HyperlinkExternalPageDestination (Optional)

HyperlinkExternalPageDestination anyItem ()
Returns any HyperlinkExternalPageDestination in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromHyperlinkExternalPageDestination
Long Integer
String
The HyperlinkExternalPageDestination, index, or name at the beginning of the range. Can accept: HyperlinkExternalPageDestination, Long Integer or String.
toHyperlinkExternalPageDestination
Long Integer
String
The HyperlinkExternalPageDestination, index, or name at the end of the range. Can accept: HyperlinkExternalPageDestination, Long Integer or String.

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

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

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

ParameterTypeDescription
objHyperlinkExternalPageDestinationThe HyperlinkExternalPageDestination whose index comes before the desired HyperlinkExternalPageDestination.

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

ParameterTypeDescription
objHyperlinkExternalPageDestinationThe index of the HyperlinkExternalPageDestination that follows the desired HyperlinkExternalPageDestination.

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

Element of

Document.hyperlinkExternalPageDestinations

Jongware, 23-Mar-2011 v3.0.3dContents :: Index