Adobe InDesign CS2 (4.0) Object Model JS: Words

InDesign CS2

Class

Words

 A collection of words.

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

Word anyItem ()
Returns any Word in the collection.

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

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

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

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

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

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromLong
String
Word
The Word, index, or name at the beginning of the range. Can accept: Word, Long or String.
toLong
String
Word
The Word, index, or name at the end of the range. Can accept: Word, Long or String.

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

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

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

ParameterTypeDescription
objWordThe Word whose index comes before the desired Word.

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

ParameterTypeDescription
objWordThe index of the Word that follows the desired Word.

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

Element of

Cell.words

Character.words

Footnote.words

InsertionPoint.words

Line.words

Note.words

Paragraph.words

Story.words

Text.words

TextColumn.words

TextFrame.words

TextPath.words

TextStyleRange.words

Word.words

XMLElement.words

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