ColorGroupSwatches

A collection of color group swatches.

Go to Property Listing | Method Listing

Methods:

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Property Listing

Property	Type	Access	Description
length	Number	readonly	The number of objects in the collection.

Method Listing

ColorGroupSwatch [] (index:Number)

Returns the ColorGroupSwatch with the specified index.

Parameter	Type	Description
index	Number	The index.

ColorGroupSwatch add (swatchItemRef:Swatch, withProperties:Object)

Adds a color group swatch.

Parameter	Type	Description
swatchItemRef	Swatch	swatch to be added to color group
withProperties	Object	Initial values for properties of the new ColorGroupSwatch (Optional)

ColorGroupSwatch anyItem ()

Returns any ColorGroupSwatch in the collection.

Number count ()

Displays the number of elements in the ColorGroupSwatch.

ColorGroupSwatch everyItem ()

Returns every ColorGroupSwatch in the collection.

ColorGroupSwatch firstItem ()

Returns the first ColorGroupSwatch in the collection.

ColorGroupSwatch item (index:Varies LongInteger String)

Returns the ColorGroupSwatch with the specified index or name.

Parameter	Type	Description
index	LongInteger String	The index or name. Can accept: Long Integer or String.

Parameter

Type

Description

index

LongInteger

String

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

ColorGroupSwatch itemByID (id:Number)

Returns the ColorGroupSwatch with the specified ID.

Parameter	Type	Description
id	Number	The ID.

ColorGroupSwatch itemByRange (from:Varies ColorGroupSwatch LongInteger String, to:Varies ColorGroupSwatch LongInteger String)

Returns the ColorGroupSwatches within the specified range.

Parameter	Type	Description
from	ColorGroupSwatch LongInteger String	The ColorGroupSwatch, index, or name at the beginning of the range. Can accept: ColorGroupSwatch, Long Integer or String.
to	ColorGroupSwatch LongInteger String	The ColorGroupSwatch, index, or name at the end of the range. Can accept: ColorGroupSwatch, Long Integer or String.

Parameter

Type

Description

from

ColorGroupSwatch

LongInteger

String

The ColorGroupSwatch, index, or name at the beginning of the range. Can accept: ColorGroupSwatch, Long Integer or String.

ColorGroupSwatch

LongInteger

String

The ColorGroupSwatch, index, or name at the end of the range. Can accept: ColorGroupSwatch, Long Integer or String.

ColorGroupSwatch lastItem ()

Returns the last ColorGroupSwatch in the collection.

ColorGroupSwatch middleItem ()

Returns the middle ColorGroupSwatch in the collection.

ColorGroupSwatch nextItem (obj:ColorGroupSwatch)

Returns the ColorGroupSwatch whose index follows the specified ColorGroupSwatch in the collection.

Parameter	Type	Description
obj	ColorGroupSwatch	The ColorGroupSwatch whose index comes before the desired ColorGroupSwatch.

ColorGroupSwatch previousItem (obj:ColorGroupSwatch)

Returns the ColorGroupSwatch with the index previous to the specified index.

Parameter	Type	Description
obj	ColorGroupSwatch	The index of the ColorGroupSwatch that follows the desired ColorGroupSwatch.

String toSource ()

Generates a string which, if executed, will return the ColorGroupSwatch.

Object of

ColorGroup.colorGroupSwatches