K4 InDesign Javascript API Documentation

TextUserDictionaries

A collection of user dictionaries.

Instance Properties

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

Methods

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