Adobe InDesign CS2 (4.0) Object Model JS: Inks

InDesign CS2

Class

Inks

 A collection of inks.

QuickLinks

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

Ink anyItem ()
Returns any Ink in the collection.

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

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

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

Ink item (index: any)
Returns the Ink with the specified index or name.

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromInk
Long
String
The Ink, index, or name at the beginning of the range. Can accept: Ink, Long or String.
toInk
Long
String
The Ink, index, or name at the end of the range. Can accept: Ink, Long or String.

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

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

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

ParameterTypeDescription
objInkThe Ink whose index comes before the desired Ink.

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

ParameterTypeDescription
objInkThe index of the Ink that follows the desired Ink.

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

Element of

Application.inks

Document.inks

Used in:

MixedInk MixedInks.add (inkList: any, inkPercentages: Array of number[, withProperties: Object])

Jongware, 27-Jun-2010 v3.0.3dContents :: Index