K4 InDesign Javascript API Documentation

HyperlinksHyperlinks

A collection of hyperlinks.

Instance Properties

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

Methods

add(
hyperlinkSource, hyperlinkDestination ​[, withProperties])
  → Hyperlink
anyItem(
)
  → Hyperlink
count(
)
  → number
everyItem(
)
  → Hyperlink
firstItem(
)
  → Hyperlink
item(
index)
  → Hyperlink
itemByID(
id)
  → Hyperlink
itemByName(
name)
  → Hyperlink
itemByRange(
from, to)
  → Hyperlink
lastItem(
)
  → Hyperlink
middleItem(
)
  → Hyperlink
nextItem(
obj)
  → Hyperlink
previousItem(
obj)
  → Hyperlink
toSource(
)
  → string
add(
hyperlinkSource, hyperlinkDestination ​[, withProperties])
  → Hyperlink
Creates a new hyperlink.
hyperlinkSource The hyperlinked object. Can accept: HyperlinkPageItemSource, HyperlinkTextSource or CrossReferenceSource.
hyperlinkDestination The destination that the hyperlink points to. Can accept: Ordered array containing fileName:String, volumn:String, directoryId:Long Integer, dataLinkClassId:Long Integer, destinationUid:Long Integer, HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination, HyperlinkURLDestination or ParagraphDestination. (Optional)
withProperties Object Initial values for properties of the new Hyperlink (Optional)
anyItem(
)
  → Hyperlink
Returns any Hyperlink in the collection.
count(
)
  → number
Displays the number of elements in the Hyperlink.
everyItem(
)
  → Hyperlink
Returns every Hyperlink in the collection.
firstItem(
)
  → Hyperlink
Returns the first Hyperlink in the collection.
item(
index)
  → Hyperlink
Returns the Hyperlink with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → Hyperlink
Returns the Hyperlink with the specified ID.
id number The ID.
itemByName(
name)
  → Hyperlink
Returns the Hyperlink with the specified name.
name string The name.
itemByRange(
from, to)
  → Hyperlink
Returns the Hyperlinks within the specified range.
from The Hyperlink, index, or name at the beginning of the range. Can accept: Hyperlink, Long Integer or String.
to The Hyperlink, index, or name at the end of the range. Can accept: Hyperlink, Long Integer or String.
lastItem(
)
  → Hyperlink
Returns the last Hyperlink in the collection.
middleItem(
)
  → Hyperlink
Returns the middle Hyperlink in the collection.
nextItem(
obj)
  → Hyperlink
Returns the Hyperlink whose index follows the specified Hyperlink in the collection.
obj Hyperlink The Hyperlink whose index comes before the desired Hyperlink.
previousItem(
obj)
  → Hyperlink
Returns the Hyperlink with the index previous to the specified index.
obj Hyperlink The index of the Hyperlink that follows the desired Hyperlink.
toSource(
)
  → string
Generates a string which, if executed, will return the Hyperlink.