Adobe InCopy CS5.5 (7.5) Object Model JS: HyperlinkPageItemSources

InCopy CS5.5

Class

HyperlinkPageItemSources

 A collection of hyperlink page item sources.

See also HyperlinkPageItemSource.

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

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

ParameterTypeDescription
indexnumberThe index.

HyperlinkPageItemSource add (source: PageItem[, withProperties: Object])
Creates a new hyperlink page item source.

ParameterTypeDescription
sourcePageItemThe page item to hyperlink.
withPropertiesObjectInitial values for properties of the new HyperlinkPageItemSource (Optional)

HyperlinkPageItemSource anyItem ()
Returns any HyperlinkPageItemSource in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromHyperlinkPageItemSource
Long Integer
String
The HyperlinkPageItemSource, index, or name at the beginning of the range. Can accept: HyperlinkPageItemSource, Long Integer or String.
toHyperlinkPageItemSource
Long Integer
String
The HyperlinkPageItemSource, index, or name at the end of the range. Can accept: HyperlinkPageItemSource, Long Integer or String.

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

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

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

ParameterTypeDescription
objHyperlinkPageItemSourceThe HyperlinkPageItemSource whose index comes before the desired HyperlinkPageItemSource.

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

ParameterTypeDescription
objHyperlinkPageItemSourceThe index of the HyperlinkPageItemSource that follows the desired HyperlinkPageItemSource.

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

Element of

Document.hyperlinkPageItemSources

Jongware, 29-Apr-2012 v3.0.3iContents :: Index