K4 InDesign Javascript API Documentation

TextParagraphs

A collection of paragraphs.

Instance Properties

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

Methods

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