Adobe InDesign CS4 (6.0) Object Model JS: HyphenationException

InDesign CS4

Class

HyphenationException

 A hyphenation exceptions list.

QuickLinks

addException, getElements, removeException, toSource, toSpecifier

Hierarchy

Document
HyphenationException

Properties

PropertyTypeAccessDescription
addedExceptionsArray of string r/wA list of words added to the hyphenation exceptions list.
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.
removedExceptionsArray of string r/wA list of words removed from the hyphenation exceptions list.

Methods

Instances

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

ParameterTypeDescription
addedExceptionsArray 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.

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

ParameterTypeDescription
removedExceptionsArray 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:

array of HyphenationException HyphenationExceptions.itemByRange (from: any, to: any)

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: any)

HyphenationException HyphenationExceptions.itemByName (name: string)

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

HyphenationException HyphenationExceptions.lastItem ()

HyphenationException HyphenationExceptions.middleItem ()

HyphenationException HyphenationExceptions.nextItem (obj: HyphenationException)

HyphenationException HyphenationExceptions.previousItem (obj: HyphenationException)

Jongware, 20-Jun-2010 v3.0.3dContents :: Index