K4 InDesign Javascript API Documentation

TextLines

A collection of lines.

Instance Properties

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

Methods

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