Adobe InDesign CS4 (6.0) Object Model JS: CrossReferenceFormats

InDesign CS4

Class

CrossReferenceFormats

 A collection of cross reference formats.

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

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

ParameterTypeDescription
indexnumberThe index.

CrossReferenceFormat add ([name: string][, withProperties: Object])
Creates a new cross reference format.

ParameterTypeDescription
namestringThe format name. (Optional)
withPropertiesObjectInitial values for properties of the new CrossReferenceFormat (Optional)

CrossReferenceFormat anyItem ()
Returns any CrossReferenceFormat in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromCrossReferenceFormat
Long Integer
String
The CrossReferenceFormat, index, or name at the beginning of the range. Can accept: CrossReferenceFormat, Long Integer or String.
toCrossReferenceFormat
Long Integer
String
The CrossReferenceFormat, index, or name at the end of the range. Can accept: CrossReferenceFormat, Long Integer or String.

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

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

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

ParameterTypeDescription
objCrossReferenceFormatThe CrossReferenceFormat whose index comes before the desired CrossReferenceFormat.

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

ParameterTypeDescription
objCrossReferenceFormatThe index of the CrossReferenceFormat that follows the desired CrossReferenceFormat.

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

Element of

Document.crossReferenceFormats

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