K4 InDesign Javascript API Documentation

HyperlinksParagraphDestinations

A collection of paragraph destinations.

Instance Properties

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

Methods

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