Class

HyphenationException

 A hyphenation exceptions list.

QuickLinks

addException, getElements, removeException, toSource, toSpecifier

Hierarchy

Document

HyphenationException

Properties

Property	Type	Access	Description
addedExceptions	Array of string	r/w	A list of words added to the hyphenation exceptions list.
index	number	readonly	The index of the HyphenationException within its containing object.
name	string	readonly	The name of the HyphenationException.
parent	Document	readonly	The parent of the HyphenationException (a Document).
properties	Object	r/w	A property that allows setting of several properties at the same time.
removedExceptions	Array of string	r/w	A 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.

Parameter	Type	Description
addedExceptions	Array of 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) (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.

Parameter	Type	Description
removedExceptions	Array of 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) (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.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, 27-Jun-2010 v3.0.3d

Contents :: Index