Class

MixedInkGroups

 A collection of mixed ink groups.

QuickLinks

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

Properties

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

Methods

Instances

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

Parameter	Type	Description
index	number	The index.

MixedInkGroup add (inkList: Array of Ink[, inkPercentages: Array of number][, repeatValues: Array of number][, incrementValues: Array of number][, withProperties: Object])
Creates a new mixed ink group.

Parameter	Type	Description
inkList	Array of Ink	The inks to include in the mix.
inkPercentages	Array of number	The percent of each ink in the ink list. (Range: 0 to 100 for each ink) (Optional)
repeatValues	Array of number	The number of repetitions for each ink in the ink list. (Range: 0 to 100 for each ink) (Optional)
incrementValues	Array of number	The increment percent per repetition for each ink. (Range: 0 to 100) Note: The cumulative ink percentage per ink cannot exceed 100.) (Optional)
withProperties	Object	Initial values for properties of the new MixedInkGroup (Optional)

MixedInkGroup anyItem ()
Returns any MixedInkGroup in the collection.

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

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

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

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

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

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

Parameter	Type	Description
id	number	The ID.

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

Parameter	Type	Description
name	string	The name.

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

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

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

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

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

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

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

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

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

Element of

Application.mixedInkGroups

Document.mixedInkGroups

Jongware, 28-Apr-2012 v3.0.3h

Contents :: Index