K4 InDesign Javascript API Documentation

HyperlinksHyperlinkPageItemSources

A collection of hyperlink page item sources.

Instance Properties

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

Methods

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