K4 InDesign Javascript API Documentation

TextHiddenTexts

A collection of hidden text objects.

Instance Properties

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

Methods

anyItem(
)
  → HiddenText
count(
)
  → number
everyItem(
)
  → HiddenText
firstItem(
)
  → HiddenText
item(
index)
  → HiddenText
itemByID(
id)
  → HiddenText
itemByName(
name)
  → HiddenText
itemByRange(
from, to)
  → HiddenText
lastItem(
)
  → HiddenText
middleItem(
)
  → HiddenText
nextItem(
obj)
  → HiddenText
previousItem(
obj)
  → HiddenText
toSource(
)
  → string
anyItem(
)
  → HiddenText
Returns any HiddenText in the collection.
count(
)
  → number
Displays the number of elements in the HiddenText.
everyItem(
)
  → HiddenText
Returns every HiddenText in the collection.
firstItem(
)
  → HiddenText
Returns the first HiddenText in the collection.
item(
index)
  → HiddenText
Returns the HiddenText with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → HiddenText
Returns the HiddenText with the specified ID.
id number The ID.
itemByName(
name)
  → HiddenText
Returns the HiddenText with the specified name.
name string The name.
itemByRange(
from, to)
  → HiddenText
Returns the HiddenTexts within the specified range.
from The HiddenText, index, or name at the beginning of the range. Can accept: HiddenText, Long Integer or String.
to The HiddenText, index, or name at the end of the range. Can accept: HiddenText, Long Integer or String.
lastItem(
)
  → HiddenText
Returns the last HiddenText in the collection.
middleItem(
)
  → HiddenText
Returns the middle HiddenText in the collection.
nextItem(
obj)
  → HiddenText
Returns the HiddenText whose index follows the specified HiddenText in the collection.
obj HiddenText The HiddenText whose index comes before the desired HiddenText.
previousItem(
obj)
  → HiddenText
Returns the HiddenText with the index previous to the specified index.
obj HiddenText The index of the HiddenText that follows the desired HiddenText.
toSource(
)
  → string
Generates a string which, if executed, will return the HiddenText.