Class

Snippets

 A collection of IDML snippets.

QuickLinks

[], 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

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

ParameterTypeDescription
indexnumberThe 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.

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromLong Integer
Snippet
String
The Snippet, index, or name at the beginning of the range. Can accept: Snippet, Long Integer or String.
toLong 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.

ParameterTypeDescription
objSnippetThe Snippet whose index comes before the desired Snippet.

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

ParameterTypeDescription
objSnippetThe 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, 17-May-2011 v3.0.3fContents :: Index