K4 InDesign Javascript API Documentation

HyperlinksHyperlinkTextDestinations

A collection of hyperlink text destinations.

Instance Properties

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

Methods

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