Snippets
QuickLinks
Properties
Property | Type | Access | Description |
---|---|---|---|
length | number | readonly | The number of objects in the collection. |
Methods
Instances
Snippet [] (index:
number)
Returns the Snippet with the specified index.
Parameter | Type | Description |
---|---|---|
index | number | The index. |
Snippet anyItem ()
Returns any Snippet in the collection.
number count ()
Displays the number of elements in the Snippet.
Array
of Snippet everyItem ()
Returns every Snippet in the collection.
Snippet firstItem ()
Returns the first Snippet in the collection.
Snippet item (index:
varies)
Returns the Snippet with the specified index or name.
Parameter | Type | Description |
---|---|---|
index | Long Integer String | The index or name. Can accept: Long Integer or String. |
Snippet itemByID (id:
number)
Returns the Snippet with the specified ID.
Parameter | Type | Description |
---|---|---|
id | number | The ID. |
Snippet itemByName (name:
string)
Returns the Snippet with the specified name.
Parameter | Type | Description |
---|---|---|
name | string | The name. |
Array
of Snippet itemByRange (from:
varies, to:
varies)
Returns the Snippets within the specified range.
Parameter | Type | Description |
---|---|---|
from | Long Integer Snippet String | The Snippet, index, or name at the beginning of the range. Can accept: Snippet, Long Integer or String. |
to | Long Integer Snippet String | The Snippet, index, or name at the end of the range. Can accept: Snippet, Long Integer or String. |
Snippet lastItem ()
Returns the last Snippet in the collection.
Snippet middleItem ()
Returns the middle Snippet in the collection.
Snippet nextItem (obj:
Snippet)
Returns the Snippet whose index follows the specified Snippet in the collection.
Parameter | Type | Description |
---|---|---|
obj | Snippet | The Snippet whose index comes before the desired Snippet. |
Snippet previousItem (obj:
Snippet)
Returns the Snippet with the index previous to the specified index.
Parameter | Type | Description |
---|---|---|
obj | Snippet | The index of the Snippet that follows the desired Snippet. |
string toSource ()
Generates a string which, if executed, will return the Snippet.
Element of
PlaceGun.snippets
Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |