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

InDesign Server CS5

Class

CrossReferenceSources

 A collection of cross reference 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

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

ParameterTypeDescription
indexnumberThe index.

CrossReferenceSource add (source: Text, appliedFormat: CrossReferenceFormat[, withProperties: Object])
Creates a new cross reference text source.

ParameterTypeDescription
sourceTextThe text or insertion point to create the source.
appliedFormatCrossReferenceFormatFormat used for cross reference source.
withPropertiesObjectInitial values for properties of the new CrossReferenceSource (Optional)

CrossReferenceSource anyItem ()
Returns any CrossReferenceSource in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromCrossReferenceSource
Long Integer
String
The CrossReferenceSource, index, or name at the beginning of the range. Can accept: CrossReferenceSource, Long Integer or String.
toCrossReferenceSource
Long Integer
String
The CrossReferenceSource, index, or name at the end of the range. Can accept: CrossReferenceSource, Long Integer or String.

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

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

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

ParameterTypeDescription
objCrossReferenceSourceThe CrossReferenceSource whose index comes before the desired CrossReferenceSource.

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

ParameterTypeDescription
objCrossReferenceSourceThe index of the CrossReferenceSource that follows the desired CrossReferenceSource.

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

Element of

Document.crossReferenceSources

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