Paragraphs¶
app.activeDocument.textFrames[index].paragraphs
Description¶
A collection of TextRange objects, with each TextRange representing a paragraph.
The elements are not named; you must access them by index.
Properties¶
Paragraphs.length¶
app.activeDocument.textFrames[index].paragraphs.length
Description¶
The number of objects in the collection.
Type¶
Number; read-only.
Paragraphs.parent¶
app.activeDocument.textFrames[index].paragraphs.parent
Description¶
The parent of this object.
Type¶
Object; read-only.
Paragraphs.typename¶
app.activeDocument.textFrames[index].paragraphs.typename
Description¶
The class name of the referenced object.
Type¶
String; read-only.
Methods¶
Paragraphs.add()¶
app.activeDocument.textFrames[index].paragraphs.add(contents [,relativeObject] [,insertionLocation])
Description¶
Adds a new paragraph with specified text contents at the specified location in the current document. If location is not specified, adds the new paragraph to the containing text frame after the current text selection or insertion point.
Parameters¶
| Parameter | Type | Description |
|---|---|---|
contents |
String | Text contents to add |
relativeObject |
TextFrameItem, optional | Object to add item to |
insertionLocation |
ElementPlacement, optional | Location to place text |
Returns¶
Paragraphs.addBefore()¶
app.activeDocument.textFrames[index].paragraphs.addBefore(contents)
Description¶
Adds a new paragraph with specified text contents before the current text selection or insertion point.
Parameters¶
| Parameter | Type | Description |
|---|---|---|
contents |
String | Text contents to add |
Returns¶
Paragraphs.index()¶
app.activeDocument.textFrames[index].paragraphs.index(itemKey)
Description¶
Gets an element from the collection.
Parameters¶
| Parameter | Type | Description |
|---|---|---|
itemKey |
String, Number | String or number key |
Returns¶
Paragraphs.removeAll()¶
app.activeDocument.textFrames[index].paragraphs.removeAll()
Description¶
Deletes all elements in this collection.
Returns¶
Nothing.
Example¶
Counting paragraphs¶
// Counts all paragraphs in current doc and stores result in paragraphCount
if (app.documents.length > 0) {
var doc = app.activeDocument;
var paragraphCount = 0;
for (var i = 0; i < doc.textFrames.length; i++) {
paragraphCount += doc.textFrames[i].paragraphs.length;
}
}