Swatches
A collection of swatches.
Go to Property Listing | Method Listing
Methods:
[], 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
Swatch [] (index:Number)
Returns the Swatch with the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
The index. |
Swatch anyItem ()
Returns any Swatch in the collection.
Number count ()
Displays the number of elements in the Swatch.
Swatch everyItem ()
Returns every Swatch in the collection.
Swatch firstItem ()
Returns the first Swatch in the collection.
Swatch item (index:Varies LongInteger String)
Returns the Swatch with the specified index or name.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
LongInteger |
The index or name. Can accept: Long Integer or String. |
Swatch itemByID (id:Number)
Returns the Swatch with the specified ID.
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
The ID. |
Swatch itemByName (name:String)
Returns the Swatch with the specified name.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name. |
Swatch itemByRange (from:Varies LongInteger Swatch String, to:Varies LongInteger Swatch String)
Returns the Swatches within the specified range.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
LongInteger |
The Swatch, index, or name at the beginning of the range. Can accept: Swatch, Long Integer or String. |
|
to |
LongInteger |
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.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The Swatch whose index comes before the desired Swatch. |
Swatch previousItem (obj:Swatch)
Returns the Swatch with the index previous to the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The index of the Swatch that follows the desired Swatch. |
String toSource ()
Generates a string which, if executed, will return the Swatch.
Object of
Application.swatches
Document.swatches