InDesign2026
API 21.5.1.73
Collection of UserDictionary

UserDictionaries

A collection of user dictionaries.

Properties

NameType AccessDescription
Number readonly The number of objects in the collection.

Methods

→ UserDictionary

Returns the UserDictionary with the specified index.

index Number The index.
→ UserDictionary

Returns any UserDictionary in the collection.

→ Number

Displays the number of elements in the UserDictionary.

→ UserDictionary[]

Returns every UserDictionary in the collection.

→ UserDictionary

Returns the first UserDictionary in the collection.

→ UserDictionary

Returns the UserDictionary with the specified index or name.

index LongInteger | String The index or name. Can accept: Long Integer or String.
→ UserDictionary

Returns the UserDictionary with the specified name.

name String The name.
→ UserDictionary[]

Returns the UserDictionaries within the specified range.

from LongInteger | UserDictionary | String The UserDictionary, index, or name at the beginning of the range. Can accept: UserDictionary, Long Integer or String.
to LongInteger | UserDictionary | String The UserDictionary, index, or name at the end of the range. Can accept: UserDictionary, Long Integer or String.
→ UserDictionary

Returns the last UserDictionary in the collection.

→ UserDictionary

Returns the middle UserDictionary in the collection.

→ UserDictionary

Returns the UserDictionary whose index follows the specified UserDictionary in the collection.

obj UserDictionary The UserDictionary whose index comes before the desired UserDictionary.
→ UserDictionary

Returns the UserDictionary with the index previous to the specified index.

obj UserDictionary The index of the UserDictionary that follows the desired UserDictionary.
→ String

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

Object of 1

Properties elsewhere that hold a UserDictionaries.