K4 InDesign Javascript API Documentation

PreferencesDisplaySettings

Display setting properties.

Instance Properties

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

Methods

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