K4 InDesign Javascript API Documentation

HyperlinksHyperlinkExternalPageDestinations

A collection of hyperlink external page destinations.

Instance Properties

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

Methods

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