Adobe InCopy CS5 (7.0) Object Model JS: HyphenationException

InCopy CS5

Class

HyphenationException

 A hyphenation exceptions list.

QuickLinks

addEventListener, addException, getElements, removeEventListener, removeException, toSource, toSpecifier

Hierarchy

Document
HyphenationException
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
addedExceptions Array of string r/wA list of words added to the hyphenation exceptions list.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
indexnumber readonlyThe index of the HyphenationException within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
namestring readonlyThe name of the HyphenationException.
parentDocument readonlyThe parent of the HyphenationException (a Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
removedExceptions Array of string r/wA list of words removed from the hyphenation exceptions list.

Methods

Instances

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

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

void addException (addedExceptions: Array of string[, removedList: bool=false])
Adds the specified words to the hyphenation exceptions list.

ParameterTypeDescription
addedExceptions Array of stringThe list of words to add.
removedListboolIf true, adds the words to the removed exceptions list. If false or unspecified, adds the words to the added exceptions list. (Optional) (default: false)

Array of HyphenationException getElements ()
Resolves the object specifier, creating an array of object references.

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

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

void removeException (removedExceptions: Array of string[, removedList: bool=false])
Removes the specified words from the hyphenation exceptions list.

ParameterTypeDescription
removedExceptions Array of stringThe list of words to remove.
removedListboolIf true, removes the words from the removed exceptions list. If false or unspecified, adds the words to the added exceptions list. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

HyphenationException HyphenationExceptions.nextItem (obj: HyphenationException)

HyphenationException HyphenationExceptions.previousItem (obj: HyphenationException)

Return

Array of HyphenationException HyphenationException.getElements ()

HyphenationException HyphenationExceptions.[] (index: number)

HyphenationException HyphenationExceptions.anyItem ()

Array of HyphenationException HyphenationExceptions.everyItem ()

HyphenationException HyphenationExceptions.firstItem ()

HyphenationException HyphenationExceptions.item (index: varies)

HyphenationException HyphenationExceptions.itemByName (name: string)

Array of HyphenationException HyphenationExceptions.itemByRange (from: varies, to: varies)

HyphenationException HyphenationExceptions.lastItem ()

HyphenationException HyphenationExceptions.middleItem ()

HyphenationException HyphenationExceptions.nextItem (obj: HyphenationException)

HyphenationException HyphenationExceptions.previousItem (obj: HyphenationException)

Jongware, 23-Mar-2011 v3.0.3dContents :: Index