Adobe InDesign CS2 (4.0) Object Model JS: HyperlinkTextSources

InDesign CS2

Class

HyperlinkTextSources

 A collection of hyperlink text sources.

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

HyperlinkTextSource add (source: Text[, withProperties: Object])
Creates a new hyperlink text source.

ParameterTypeDescription
sourceTextThe text or insertion point to hyperlink.
withPropertiesObjectInitial values for properties of the new HyperlinkTextSource (Optional)

HyperlinkTextSource anyItem ()
Returns any HyperlinkTextSource in the collection.

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

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

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

HyperlinkTextSource item (index: any)
Returns the HyperlinkTextSource with the specified index or name.

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

Array of HyperlinkTextSource itemByRange (from: any, to: any)
Returns the HyperlinkTextSources within the specified range.

ParameterTypeDescription
fromHyperlinkTextSource
Long
String
The HyperlinkTextSource, index, or name at the beginning of the range. Can accept: HyperlinkTextSource, Long or String.
toHyperlinkTextSource
Long
String
The HyperlinkTextSource, index, or name at the end of the range. Can accept: HyperlinkTextSource, Long or String.

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

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

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

ParameterTypeDescription
objHyperlinkTextSourceThe HyperlinkTextSource whose index comes before the desired HyperlinkTextSource.

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

ParameterTypeDescription
objHyperlinkTextSourceThe index of the HyperlinkTextSource that follows the desired HyperlinkTextSource.

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

Element of

Document.hyperlinkTextSources

Jongware, 27-Jun-2010 v3.0.3dContents :: Index