K4 InDesign Javascript API Documentation

HyperlinksCrossReferenceSources

A collection of cross reference text sources.

Instance Properties

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

Methods

add(
source, appliedFormat ​[, withProperties])
  → CrossReferenceSource
anyItem(
)
  → CrossReferenceSource
count(
)
  → number
everyItem(
)
  → CrossReferenceSource
firstItem(
)
  → CrossReferenceSource
item(
index)
  → CrossReferenceSource
itemByID(
id)
  → CrossReferenceSource
itemByName(
name)
  → CrossReferenceSource
itemByRange(
from, to)
  → CrossReferenceSource
lastItem(
)
  → CrossReferenceSource
middleItem(
)
  → CrossReferenceSource
nextItem(
obj)
  → CrossReferenceSource
previousItem(
obj)
  → CrossReferenceSource
toSource(
)
  → string
add(
source, appliedFormat ​[, withProperties])
  → CrossReferenceSource
Creates a new cross reference text source.
source Text The text or insertion point to create the source.
appliedFormat CrossReferenceFormat Format used for cross reference source.
withProperties Object Initial values for properties of the new CrossReferenceSource (Optional)
anyItem(
)
  → CrossReferenceSource
Returns any CrossReferenceSource in the collection.
count(
)
  → number
Displays the number of elements in the CrossReferenceSource.
everyItem(
)
  → CrossReferenceSource
Returns every CrossReferenceSource in the collection.
firstItem(
)
  → CrossReferenceSource
Returns the first CrossReferenceSource in the collection.
item(
index)
  → CrossReferenceSource
Returns the CrossReferenceSource with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → CrossReferenceSource
Returns the CrossReferenceSource with the specified ID.
id number The ID.
itemByName(
name)
  → CrossReferenceSource
Returns the CrossReferenceSource with the specified name.
name string The name.
itemByRange(
from, to)
  → CrossReferenceSource
Returns the CrossReferenceSources within the specified range.
from The CrossReferenceSource, index, or name at the beginning of the range. Can accept: CrossReferenceSource, Long Integer or String.
to The CrossReferenceSource, index, or name at the end of the range. Can accept: CrossReferenceSource, Long Integer or String.
lastItem(
)
  → CrossReferenceSource
Returns the last CrossReferenceSource in the collection.
middleItem(
)
  → CrossReferenceSource
Returns the middle CrossReferenceSource in the collection.
nextItem(
obj)
  → CrossReferenceSource
Returns the CrossReferenceSource whose index follows the specified CrossReferenceSource in the collection.
obj CrossReferenceSource The CrossReferenceSource whose index comes before the desired CrossReferenceSource.
previousItem(
obj)
  → CrossReferenceSource
Returns the CrossReferenceSource with the index previous to the specified index.
obj CrossReferenceSource The index of the CrossReferenceSource that follows the desired CrossReferenceSource.
toSource(
)
  → string
Generates a string which, if executed, will return the CrossReferenceSource.