K4 InDesign Javascript API Documentation

TextHyphenationException

A hyphenation exceptions list.

Instance Properties

Name Description Access
addedExceptions string A list of words added to the hyphenation exceptions list. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
index number The index of the HyphenationException within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
name string The name of the HyphenationException. read-only
parent Document The parent of the HyphenationException (a Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write
removedExceptions string A list of words removed from the hyphenation exceptions list. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
addException(
addedExceptions ​[, removedList])
getElements(
)
  → HyphenationException
removeEventListener(
eventType, handler ​[, captures])
  → bool
removeException(
removedExceptions ​[, removedList])
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)
addException(
addedExceptions ​[, removedList=false])
Adds the specified words to the hyphenation exceptions list.
addedExceptions Array<string> The list of words to add.
removedList bool If true, adds the words to the removed exceptions list. If false or unspecified, adds the words to the added exceptions list. (Optional)
getElements(
)
  → HyphenationException
Resolves the object specifier, creating an array of object references.
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)
removeException(
removedExceptions ​[, removedList=false])
Removes the specified words from the hyphenation exceptions list.
removedExceptions Array<string> The list of words to remove.
removedList bool If true, removes the words from the removed exceptions list. If false or unspecified, adds the words to the added exceptions list. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the HyphenationException.
toSpecifier(
)
  → string
Retrieves the object specifier.