Adobe InCopy CS6 (8.0) Object Model JS: TrapPresets

InCopy CS6

Class

TrapPresets

 A collection of trap presets.

See also TrapPreset.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

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

ParameterTypeDescription
indexnumberThe index.

TrapPreset add ([withProperties: Object])
Creates a new TrapPreset.

ParameterTypeDescription
withPropertiesObjectInitial values for properties of the new TrapPreset (Optional)

TrapPreset anyItem ()
Returns any TrapPreset in the collection.

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

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

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

TrapPreset item (index: varies)
Returns the TrapPreset with the specified index or name.

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

TrapPreset itemByID (id: number)
Returns the TrapPreset with the specified ID.

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

Array of TrapPreset itemByRange (from: varies, to: varies)
Returns the TrapPresets within the specified range.

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

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

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

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

ParameterTypeDescription
objTrapPresetThe TrapPreset whose index comes before the desired TrapPreset.

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

ParameterTypeDescription
objTrapPresetThe index of the TrapPreset that follows the desired TrapPreset.

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

Element of

Application.trapPresets

Document.trapPresets

Jongware, 29-Apr-2012 v3.0.3iContents :: Index