K4 InDesign Javascript API Documentation

IndexingCrossReferences

A collection of index cross references. (For cross references in text, use the 'cross reference source' and 'hyperlink' objects.)

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
referencedTopic, crossReferenceType ​[, customTypeString] ​[, withProperties])
  → CrossReference
anyItem(
)
  → CrossReference
count(
)
  → number
everyItem(
)
  → CrossReference
firstItem(
)
  → CrossReference
item(
index)
  → CrossReference
itemByID(
id)
  → CrossReference
itemByName(
name)
  → CrossReference
itemByRange(
from, to)
  → CrossReference
lastItem(
)
  → CrossReference
middleItem(
)
  → CrossReference
nextItem(
obj)
  → CrossReference
previousItem(
obj)
  → CrossReference
toSource(
)
  → string
add(
referencedTopic, crossReferenceType ​[, customTypeString] ​[, withProperties])
  → CrossReference
Creates a new cross reference.
referencedTopic Topic The topic that the cross reference points to.
crossReferenceType CrossReferenceType The cross reference type.
customTypeString string The custom string to use in the cross reference. Valid only for custom cross reference types. (Optional)
withProperties Object Initial values for properties of the new CrossReference (Optional)
anyItem(
)
  → CrossReference
Returns any CrossReference in the collection.
count(
)
  → number
Displays the number of elements in the CrossReference.
everyItem(
)
  → CrossReference
Returns every CrossReference in the collection.
firstItem(
)
  → CrossReference
Returns the first CrossReference in the collection.
item(
index)
  → CrossReference
Returns the CrossReference with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → CrossReference
Returns the CrossReference with the specified ID.
id number The ID.
itemByName(
name)
  → CrossReference
Returns the CrossReference with the specified name.
name string The name.
itemByRange(
from, to)
  → CrossReference
Returns the CrossReferences within the specified range.
from The CrossReference, index, or name at the beginning of the range. Can accept: CrossReference, Long Integer or String.
to The CrossReference, index, or name at the end of the range. Can accept: CrossReference, Long Integer or String.
lastItem(
)
  → CrossReference
Returns the last CrossReference in the collection.
middleItem(
)
  → CrossReference
Returns the middle CrossReference in the collection.
nextItem(
obj)
  → CrossReference
Returns the CrossReference whose index follows the specified CrossReference in the collection.
obj CrossReference The CrossReference whose index comes before the desired CrossReference.
previousItem(
obj)
  → CrossReference
Returns the CrossReference with the index previous to the specified index.
obj CrossReference The index of the CrossReference that follows the desired CrossReference.
toSource(
)
  → string
Generates a string which, if executed, will return the CrossReference.