Adobe InDesign CS4 (6.0) Object Model JS: Preferences

InDesign CS4

Class

Preferences

 A collection of preferences objects.

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

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

ParameterTypeDescription
indexnumberThe index.

Preference anyItem ()
Returns any Preference in the collection.

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

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

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

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

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

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

ParameterTypeDescription
namestringThe name.

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

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

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

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

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

ParameterTypeDescription
objPreferenceThe Preference whose index comes before the desired Preference.

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

ParameterTypeDescription
objPreferenceThe index of the Preference that follows the desired Preference.

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

Element of

Application.preferences

Document.preferences

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