K4 InDesign Javascript API Documentation

TextTextFrames

A collection of text frames.

Instance Properties

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

Methods

add(
[layer] ​[, at], reference ​[, withProperties])
  → TextFrame
anyItem(
)
  → TextFrame
count(
)
  → number
everyItem(
)
  → TextFrame
firstItem(
)
  → TextFrame
item(
index)
  → TextFrame
itemByID(
id)
  → TextFrame
itemByName(
name)
  → TextFrame
itemByRange(
from, to)
  → TextFrame
lastItem(
)
  → TextFrame
middleItem(
)
  → TextFrame
nextItem(
obj)
  → TextFrame
previousItem(
obj)
  → TextFrame
toSource(
)
  → string
add(
[layer] ​[, at=LocationOptions.UNKNOWN], reference ​[, withProperties])
  → TextFrame
Creates a new TextFrame
layer Layer The layer on which to create the TextFrame. (Optional)
at LocationOptions The location at which to insert the TextFrame relative to the reference object or within the container object. (Optional)
reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional)
withProperties Object Initial values for properties of the new TextFrame (Optional)
anyItem(
)
  → TextFrame
Returns any TextFrame in the collection.
count(
)
  → number
Displays the number of elements in the TextFrame.
everyItem(
)
  → TextFrame
Returns every TextFrame in the collection.
firstItem(
)
  → TextFrame
Returns the first TextFrame in the collection.
item(
index)
  → TextFrame
Returns the TextFrame with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → TextFrame
Returns the TextFrame with the specified ID.
id number The ID.
itemByName(
name)
  → TextFrame
Returns the TextFrame with the specified name.
name string The name.
itemByRange(
from, to)
  → TextFrame
Returns the TextFrames within the specified range.
from The TextFrame, index, or name at the beginning of the range. Can accept: TextFrame, Long Integer or String.
to The TextFrame, index, or name at the end of the range. Can accept: TextFrame, Long Integer or String.
lastItem(
)
  → TextFrame
Returns the last TextFrame in the collection.
middleItem(
)
  → TextFrame
Returns the middle TextFrame in the collection.
nextItem(
obj)
  → TextFrame
Returns the TextFrame whose index follows the specified TextFrame in the collection.
obj TextFrame The TextFrame whose index comes before the desired TextFrame.
previousItem(
obj)
  → TextFrame
Returns the TextFrame with the index previous to the specified index.
obj TextFrame The index of the TextFrame that follows the desired TextFrame.
toSource(
)
  → string
Generates a string which, if executed, will return the TextFrame.