A collection of trap presets.
Methods
TrapPresetadd ([withProperties:
Object])
Creates a new TrapPreset.
| Parameter | Type | Description |
|---|---|---|
| withProperties | Object | Initial values for properties of the new TrapPreset (Optional) |
TrapPresetanyItem ()
Returns any TrapPreset in the collection.
number count ()
Displays the number of elements in the TrapPreset.
Array of TrapPreseteveryItem ()
Returns every TrapPreset in the collection.
TrapPresetfirstItem ()
Returns the first TrapPreset in the collection.
TrapPresetitem (index:
any)
Returns the TrapPreset with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String |
The index or name. Can accept: Long Integer or String. |
TrapPresetitemByID (id:
number)
Returns the TrapPreset with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
TrapPresetitemByName (name:
string)
Returns the TrapPreset with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of TrapPresetitemByRange (from:
any, to:
any)
Returns the TrapPresets within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | TrapPreset Long Integer String |
The TrapPreset, index, or name at the beginning of the range. Can accept: TrapPreset, Long Integer or String. |
| to | TrapPreset Long Integer String |
The TrapPreset, index, or name at the end of the range. Can accept: TrapPreset, Long Integer or String. |
TrapPresetlastItem ()
Returns the last TrapPreset in the collection.
TrapPresetmiddleItem ()
Returns the middle TrapPreset in the collection.
TrapPresetnextItem (obj:
TrapPreset)
Returns the TrapPreset whose index follows the specified TrapPreset in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | TrapPreset | The TrapPreset whose index comes before the desired TrapPreset. |
TrapPresetpreviousItem (obj:
TrapPreset)
Returns the TrapPreset with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | TrapPreset | The 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