K4 InDesign Javascript API Documentation

TextTextColumns

A collection of text columns.

Instance Properties

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

Methods

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