Adobe InDesign CS2 (4.0) Object Model JS: HyphenationExceptions

InDesign CS2

Class

HyphenationExceptions

 A collection of hyphenation exceptions lists.

QuickLinks

anyItem, count, everyItem, firstItem, item, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

HyphenationException anyItem ()
Returns any HyphenationException in the collection.

number count ()
Displays the number of elements in the HyphenationException.

Array of HyphenationException everyItem ()
Returns every HyphenationException in the collection.

HyphenationException firstItem ()
Returns the first HyphenationException in the collection.

HyphenationException item (index: any)
Returns the HyphenationException with the specified index or name.

ParameterTypeDescription
indexLong
String
The index or name. Can accept: Long or String.

HyphenationException itemByName (name: string)
Returns the HyphenationException with the specified name.

ParameterTypeDescription
namestringThe name.

Array of HyphenationException itemByRange (from: any, to: any)
Returns the HyphenationExceptions within the specified range.

ParameterTypeDescription
fromHyphenationException
Long
String
The HyphenationException, index, or name at the beginning of the range. Can accept: HyphenationException, Long or String.
toHyphenationException
Long
String
The HyphenationException, index, or name at the end of the range. Can accept: HyphenationException, Long or String.

HyphenationException lastItem ()
Returns the last HyphenationException in the collection.

HyphenationException middleItem ()
Returns the middle HyphenationException in the collection.

HyphenationException nextItem (obj: HyphenationException)
Returns the HyphenationException whose index follows the specified HyphenationException in the collection.

ParameterTypeDescription
objHyphenationExceptionThe HyphenationException whose index comes before the desired HyphenationException.

HyphenationException previousItem (obj: HyphenationException)
Returns the HyphenationException with the index previous to the specified index.

ParameterTypeDescription
objHyphenationExceptionThe index of the HyphenationException that follows the desired HyphenationException.

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

Element of

Document.hyphenationExceptions

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