Adobe InDesign CS3 (5.0) Object Model JS: MixedInkGroups

InDesign CS3

Class

MixedInkGroups

 A collection of mixed ink groups.

QuickLinks

add, 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

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.

ParameterTypeDescription
inkList Array of InkThe inks to include in the mix.
inkPercentages Array of numberThe percent of each ink in the ink list. (Range: 0 to 100 for each ink) (Optional)
repeatValues Array of numberThe number of repetitions for each ink in the ink list. (Range: 0 to 100 for each ink) (Optional)
incrementValues Array of numberThe increment percent per repetition for each ink. (Range: 0 to 100) Note: The cumulative ink percentage per ink cannot exceed 100.) (Optional)
withPropertiesObjectInitial 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: any)
Returns the MixedInkGroup with the specified index or name.

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromLong Integer
MixedInkGroup
String
The MixedInkGroup, index, or name at the beginning of the range. Can accept: MixedInkGroup, Long Integer or String.
toLong 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.

ParameterTypeDescription
objMixedInkGroupThe MixedInkGroup whose index comes before the desired MixedInkGroup.

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

ParameterTypeDescription
objMixedInkGroupThe 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, 27-Jun-2010 v3.0.3dContents :: Index