InDesign Server2025
API 20.5.0.49
Object

HyphenationException

A hyphenation exceptions list.

Hierarchy

Document

HyphenationException

Properties

NameType AccessDescription
String[] read/write A list of words added to the hyphenation exceptions list.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The index of the HyphenationException within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String readonly The name of the HyphenationException.
Document readonly The parent of the HyphenationException (a Document).
Object read/write A property that allows setting of several properties at the same time.
String[] read/write A list of words removed from the hyphenation exceptions list.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
void

Adds the specified words to the hyphenation exceptions list.

addedExceptions String[] The list of words to add.
removedList? Boolean If true, adds the words to the removed exceptions list. If false or unspecified, adds the words to the added exceptions list.
HyphenationException[]

Resolves the object specifier, creating an array of object references.

Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
void

Removes the specified words from the hyphenation exceptions list.

removedExceptions String[] The list of words to remove.
removedList? Boolean If true, removes the words from the removed exceptions list. If false or unspecified, adds the words to the added exceptions list.
String

Generates a string which, if executed, will return the HyphenationException.

String

Retrieves the object specifier.

Object of 3

Properties elsewhere that hold a HyphenationException.

Parameter of 3

Method parameters that accept a HyphenationException.

Return 12

Methods that return a HyphenationException.