PreferencesDocumentPresets

A collection of document presets.

Instance Properties

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

Methods

add(
[withProperties])
 → DocumentPreset
count(
)
 → number
item(
index)
 → DocumentPreset
itemByName(
name)
 → DocumentPreset
itemByRange(
from, to)
 → DocumentPreset
nextItem(
obj)
 → DocumentPreset
toSource(
)
 → string
add(
[withProperties])
 → DocumentPreset
Creates a new DocumentPreset.
withProperties Object Initial values for properties of the new DocumentPreset (Optional)
anyItem(
)
 → DocumentPreset
Returns any DocumentPreset in the collection.
count(
)
 → number
Displays the number of elements in the DocumentPreset.
everyItem(
)
 → DocumentPreset
Returns every DocumentPreset in the collection.
firstItem(
)
 → DocumentPreset
Returns the first DocumentPreset in the collection.
item(
index)
 → DocumentPreset
Returns the DocumentPreset with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
 → DocumentPreset
Returns the DocumentPreset with the specified ID.
id number The ID.
itemByName(
name)
 → DocumentPreset
Returns the DocumentPreset with the specified name.
name string The name.
itemByRange(
from, to)
 → DocumentPreset
Returns the DocumentPresets within the specified range.
from The DocumentPreset, index, or name at the beginning of the range. Can accept: DocumentPreset, Long Integer or String.
to The DocumentPreset, index, or name at the end of the range. Can accept: DocumentPreset, Long Integer or String.
lastItem(
)
 → DocumentPreset
Returns the last DocumentPreset in the collection.
middleItem(
)
 → DocumentPreset
Returns the middle DocumentPreset in the collection.
nextItem(
obj)
 → DocumentPreset
Returns the DocumentPreset whose index follows the specified DocumentPreset in the collection.
obj DocumentPreset The DocumentPreset whose index comes before the desired DocumentPreset.
previousItem(
obj)
 → DocumentPreset
Returns the DocumentPreset with the index previous to the specified index.
obj DocumentPreset The index of the DocumentPreset that follows the desired DocumentPreset.
toSource(
)
 → string
Generates a string which, if executed, will return the DocumentPreset.