K4 InDesign Javascript API Documentation

TextTexts

A collection of text objects.

Instance Properties

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

Methods

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