Adobe InCopy CS5 (7.0) Object Model JS: Ink

previous page next page

Class

Ink

An ink.

Ink

Property	Type	Access	Description
aliasInkName	string	r/w	The ink object to map this ink to.
angle	number (range: 0 - 360)	r/w	The angle of the ink. (Range: 0 to 360)
convertToProcess	bool	r/w	Converts spot inks to process inks.
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
frequency	number (range: 1 - 500)	r/w	The frequency of the ink. (Range: 1 to 500)
id	number	readonly	The unique ID of the Ink.
index	number	readonly	The index of the Ink within its containing object.
inkType	InkTypes: InkTypes.NORMAL InkTypes.OPAQUE InkTypes.TRANSPARENT InkTypes.OPAQUE_IGNORE	r/w	The trapping type of the ink.
isProcessInk	bool	readonly	If true, the ink is a process ink.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
label	string	r/w	A property that can be set to any string.
name	string	readonly	The name of the Ink.
neutralDensity	number (range: 0.001 - 10)	r/w	The neutral density of the ink. (Range: 0.001 to 10.0)
parent	Application Document	readonly	The parent of the Ink (a Application or Document).
printInk	bool	r/w	If true, prints the ink. Only valid when printing separations.
properties	Object	r/w	A property that allows setting of several properties at the same time.
solidity	number (range: 0 - 1)	readonly	The solidity value of the ink. (Range: 0.0 to 1.0)
trapOrder	number	r/w	The place of the ink in the trapping sequence.

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

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

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

Parameter	Type	Description
key	string	The 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.

Parameter	Type	Description
key	string	The key.
value	string	The value.

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

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)