Adobe InDesign CS5 (7.0) Object Model JS: Ink

InDesign CS5

Class

Ink

 An ink.

QuickLinks

addEventListener, extractLabel, getElements, insertLabel, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
Ink
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
aliasInkNamestring r/wThe ink object to map this ink to.
anglenumber (range: 0 - 360) r/wThe angle of the ink. (Range: 0 to 360)
convertToProcessbool r/wConverts spot inks to process inks.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
frequencynumber (range: 1 - 500) r/wThe frequency of the ink. (Range: 1 to 500)
idnumber readonlyThe unique ID of the Ink.
indexnumber readonlyThe index of the Ink within its containing object.
inkTypeInkTypes:
InkTypes.NORMAL
InkTypes.OPAQUE
InkTypes.TRANSPARENT
InkTypes.OPAQUE_IGNORE
r/wThe trapping type of the ink.
isProcessInkbool readonlyIf true, the ink is a process ink.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
namestring readonlyThe name of the Ink.
neutralDensitynumber (range: 0.001 - 10) r/wThe neutral density of the ink. (Range: 0.001 to 10.0)
parentApplication
Document
readonlyThe parent of the Ink (a Application or Document).
printInkbool r/wIf true, prints the ink. Only valid when printing separations.
propertiesObject r/wA property that allows setting of several properties at the same time.
soliditynumber (range: 0 - 1) readonlyThe solidity value of the ink. (Range: 0.0 to 1.0)
trapOrdernumber r/wThe place of the ink in the trapping sequence.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

Array of Ink getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

MixedInk.inkList

MixedInkGroup.inkList

Used in:

Ink Inks.nextItem (obj: Ink)

Ink Inks.previousItem (obj: Ink)

MixedInkGroup MixedInkGroups.add (inkList: Array of Ink[, inkPercentages: Array of number][, repeatValues: Array of number][, incrementValues: Array of number][, withProperties: Object])

Return

Array of Ink Ink.getElements ()

Ink Inks.[] (index: number)

Ink Inks.anyItem ()

Array of Ink Inks.everyItem ()

Ink Inks.firstItem ()

Ink Inks.item (index: varies)

Ink Inks.itemByID (id: number)

Ink Inks.itemByName (name: string)

Array of Ink Inks.itemByRange (from: varies, to: varies)

Ink Inks.lastItem ()

Ink Inks.middleItem ()

Ink Inks.nextItem (obj: Ink)

Ink Inks.previousItem (obj: Ink)

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