K4 InDesign Javascript API Documentation

TextHyphenationExceptions

A collection of hyphenation exceptions lists.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

anyItem(
)
  → HyphenationException
count(
)
  → number
everyItem(
)
  → HyphenationException
firstItem(
)
  → HyphenationException
item(
index)
  → HyphenationException
itemByName(
name)
  → HyphenationException
itemByRange(
from, to)
  → HyphenationException
lastItem(
)
  → HyphenationException
middleItem(
)
  → HyphenationException
nextItem(
obj)
  → HyphenationException
previousItem(
obj)
  → HyphenationException
toSource(
)
  → string
anyItem(
)
  → HyphenationException
Returns any HyphenationException in the collection.
count(
)
  → number
Displays the number of elements in the HyphenationException.
everyItem(
)
  → HyphenationException
Returns every HyphenationException in the collection.
firstItem(
)
  → HyphenationException
Returns the first HyphenationException in the collection.
item(
index)
  → HyphenationException
Returns the HyphenationException with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByName(
name)
  → HyphenationException
Returns the HyphenationException with the specified name.
name string The name.
itemByRange(
from, to)
  → HyphenationException
Returns the HyphenationExceptions within the specified range.
from The HyphenationException, index, or name at the beginning of the range. Can accept: HyphenationException, Long Integer or String.
to The HyphenationException, index, or name at the end of the range. Can accept: HyphenationException, Long Integer or String.
lastItem(
)
  → HyphenationException
Returns the last HyphenationException in the collection.
middleItem(
)
  → HyphenationException
Returns the middle HyphenationException in the collection.
nextItem(
obj)
  → HyphenationException
Returns the HyphenationException whose index follows the specified HyphenationException in the collection.
obj HyphenationException The HyphenationException whose index comes before the desired HyphenationException.
previousItem(
obj)
  → HyphenationException
Returns the HyphenationException with the index previous to the specified index.
obj HyphenationException The index of the HyphenationException that follows the desired HyphenationException.
toSource(
)
  → string
Generates a string which, if executed, will return the HyphenationException.