Adobe InDesign CS4 (6.0) Object Model JS: UserDictionaries

InDesign CS4

Class

UserDictionaries

 A collection of user dictionaries.

QuickLinks

[], anyItem, count, everyItem, firstItem, item, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

UserDictionary [] (index: number)
Returns the UserDictionary with the specified index.

ParameterTypeDescription
indexnumberThe index.

UserDictionary anyItem ()
Returns any UserDictionary in the collection.

number count ()
Displays the number of elements in the UserDictionary.

Array of UserDictionary everyItem ()
Returns every UserDictionary in the collection.

UserDictionary firstItem ()
Returns the first UserDictionary in the collection.

UserDictionary item (index: any)
Returns the UserDictionary with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

UserDictionary itemByName (name: string)
Returns the UserDictionary with the specified name.

ParameterTypeDescription
namestringThe name.

Array of UserDictionary itemByRange (from: any, to: any)
Returns the UserDictionaries within the specified range.

ParameterTypeDescription
fromLong Integer
String
UserDictionary
The UserDictionary, index, or name at the beginning of the range. Can accept: UserDictionary, Long Integer or String.
toLong Integer
String
UserDictionary
The UserDictionary, index, or name at the end of the range. Can accept: UserDictionary, Long Integer or String.

UserDictionary lastItem ()
Returns the last UserDictionary in the collection.

UserDictionary middleItem ()
Returns the middle UserDictionary in the collection.

UserDictionary nextItem (obj: UserDictionary)
Returns the UserDictionary whose index follows the specified UserDictionary in the collection.

ParameterTypeDescription
objUserDictionaryThe UserDictionary whose index comes before the desired UserDictionary.

UserDictionary previousItem (obj: UserDictionary)
Returns the UserDictionary with the index previous to the specified index.

ParameterTypeDescription
objUserDictionaryThe index of the UserDictionary that follows the desired UserDictionary.

string toSource ()
Generates a string which, if executed, will return the UserDictionary.

Element of

Application.userDictionaries

Jongware, 20-Jun-2010 v3.0.3dContents :: Index