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

InDesign Server CS5

Class

Links

 A collection of links.

QuickLinks

[], 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

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

ParameterTypeDescription
indexnumberThe index.

Link anyItem ()
Returns any Link in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromLink
Long Integer
String
The Link, index, or name at the beginning of the range. Can accept: Link, Long Integer or String.
toLink
Long Integer
String
The Link, index, or name at the end of the range. Can accept: Link, Long Integer or String.

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

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

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

ParameterTypeDescription
objLinkThe Link whose index comes before the desired Link.

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

ParameterTypeDescription
objLinkThe index of the Link that follows the desired Link.

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

Element of

Document.links

Link.links

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