Adobe InCopy CS5 (7.0) Object Model JS: KinsokuTable

previous page next page

Class

KinsokuTable

The kinsoku table.

KinsokuTable

Property	Type	Access	Description
cantBeSeparatedChars	string	r/w	The characters in the kinsoku set that cannot be separated.
cantBeginLineChars	string	r/w	The characters in the kinsoku set that cannot begin lines.
cantEndLineChars	string	r/w	That characters in the kinsoku set that cannot end lines.
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
hangingPunctuationChars	string	r/w	The hanging punctuation characters in the kinsoku set.
id	number	readonly	The unique ID of the KinsokuTable.
index	number	readonly	The index of the KinsokuTable within its containing object.
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	r/w	The name of the KinsokuTable.
parent	Application Document	readonly	The parent of the KinsokuTable (a Document or Application).
properties	Object	r/w	A property that allows setting of several properties at the same time.

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 KinsokuTable 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.

void remove ()
Deletes the KinsokuTable.

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)