Class

Swatches

 A collection of swatches.

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

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

ParameterTypeDescription
indexnumberThe index.

Swatch anyItem ()
Returns any Swatch in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

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

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

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

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

ParameterTypeDescription
objSwatchThe Swatch whose index comes before the desired Swatch.

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

ParameterTypeDescription
objSwatchThe index of the Swatch that follows the desired Swatch.

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

Element of

Application.swatches

Document.swatches

Jongware, 28-Apr-2012 v3.0.3hContents :: Index