K4 InDesign Javascript API Documentation

HyperlinksHyperlinkTextSources

A collection of hyperlink text sources.

Instance Properties

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

Methods

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