K4 InDesign Javascript API Documentation

HyperlinksHyperlinkURLDestinations

A collection of hyperlink URL destinations.

Instance Properties

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

Methods

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