K4 InDesign Javascript API Documentation

HyperlinksHyperlinkPageDestinations

A collection of hyperlink page destinations.

Instance Properties

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

Methods

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