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