Adobe InDesign CS4 (6.0) Object Model JS: Paragraphs

InDesign CS4

Class

Paragraphs

 A collection of paragraphs.

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

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

ParameterTypeDescription
indexnumberThe index.

Paragraph anyItem ()
Returns any Paragraph in the collection.

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

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

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

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

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

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

ParameterTypeDescription
namestringThe name.

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

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

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

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

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

ParameterTypeDescription
objParagraphThe Paragraph whose index comes before the desired Paragraph.

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

ParameterTypeDescription
objParagraphThe index of the Paragraph that follows the desired Paragraph.

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

Element of

Cell.paragraphs

Change.paragraphs

Character.paragraphs

Footnote.paragraphs

HiddenText.paragraphs

InsertionPoint.paragraphs

Line.paragraphs

Note.paragraphs

Paragraph.paragraphs

Story.paragraphs

Text.paragraphs

TextColumn.paragraphs

TextFrame.paragraphs

TextPath.paragraphs

TextStyleRange.paragraphs

Word.paragraphs

XMLElement.paragraphs

XmlStory.paragraphs

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