K4 InDesign Javascript API Documentation

TextKinsokuTable

The kinsoku table.

Instance Properties

Name Description Access
cantBeSeparatedChars string The characters in the kinsoku set that cannot be separated. read-write
cantBeginLineChars string The characters in the kinsoku set that cannot begin lines. read-write
cantEndLineChars string That characters in the kinsoku set that cannot end lines. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
hangingPunctuationChars string The hanging punctuation characters in the kinsoku set. read-write
id number The unique ID of the KinsokuTable. read-only
index number The index of the KinsokuTable within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
name string The name of the KinsokuTable. read-write
parent The parent of the KinsokuTable (a Document or Application). read-only
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
extractLabel(
key)
  → string
getElements(
)
  → KinsokuTable
insertLabel(
key, value)
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → KinsokuTable
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
remove(
)
Deletes the KinsokuTable.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the KinsokuTable.
toSpecifier(
)
  → string
Retrieves the object specifier.