K4 InDesign Javascript API Documentation

PreferencesPreferences

A collection of preferences objects.

Instance Properties

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

Methods

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