TrapPresets
A collection of trap presets.
Go to Property Listing | Method Listing
Methods:
[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource
Property Listing
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
The number of objects in the collection. |
Method Listing
TrapPreset [] (index:Number)
Returns the TrapPreset with the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
The index. |
TrapPreset add (withProperties:Object)
Creates a new TrapPreset.
|
Parameter |
Type |
Description |
|---|---|---|
|
withProperties |
Initial 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.
TrapPreset everyItem ()
Returns every TrapPreset in the collection.
TrapPreset firstItem ()
Returns the first TrapPreset in the collection.
TrapPreset item (index:Varies LongInteger String)
Returns the TrapPreset with the specified index or name.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
LongInteger |
The index or name. Can accept: Long Integer or String. |
TrapPreset itemByID (id:Number)
Returns the TrapPreset with the specified ID.
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
The ID. |
TrapPreset itemByName (name:String)
Returns the TrapPreset with the specified name.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name. |
TrapPreset itemByRange (from:Varies LongInteger TrapPreset String, to:Varies LongInteger TrapPreset String)
Returns the TrapPresets within the specified range.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
LongInteger |
The TrapPreset, index, or name at the beginning of the range. Can accept: TrapPreset, Long Integer or String. |
|
to |
LongInteger |
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.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The TrapPreset whose index comes before the desired TrapPreset. |
TrapPreset previousItem (obj:TrapPreset)
Returns the TrapPreset with the index previous to the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The index of the TrapPreset that follows the desired TrapPreset. |
String toSource ()
Generates a string which, if executed, will return the TrapPreset.
Object of
Application.trapPresets
Document.trapPresets