K4 InDesign Javascript API Documentation

TextWords

A collection of words.

Instance Properties

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

Methods

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