Adobe InDesign CS5.5 Server (7.5) Object Model JS: Words

InDesign Server CS5.5

Class

Words

 A collection of words.

See also Word.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

Word [] (index: number)
Returns the Word with the specified index.

ParameterTypeDescription
indexnumberThe index.

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: varies)
Returns the Word with the specified index or name.

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

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

ParameterTypeDescription
fromLong Integer
String
Word
The Word, index, or name at the beginning of the range. Can accept: Word, Long Integer or String.
toLong Integer
String
Word
The Word, index, or name at the end of the range. Can accept: Word, Long Integer 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

Change.words

Character.words

Footnote.words

HiddenText.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

XmlStory.words

Jongware, 28-Apr-2012 v3.0.3iContents :: Index