K4 InDesign Javascript API Documentation

Interactive ElementsTextBoxes

A collection of text boxes.

Instance Properties

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

Methods

add(
[layer] ​[, at], reference ​[, withProperties])
  → TextBox
anyItem(
)
  → TextBox
count(
)
  → number
everyItem(
)
  → TextBox
firstItem(
)
  → TextBox
item(
index)
  → TextBox
itemByID(
id)
  → TextBox
itemByName(
name)
  → TextBox
itemByRange(
from, to)
  → TextBox
lastItem(
)
  → TextBox
middleItem(
)
  → TextBox
nextItem(
obj)
  → TextBox
previousItem(
obj)
  → TextBox
toSource(
)
  → string
add(
[layer] ​[, at=LocationOptions.UNKNOWN], reference ​[, withProperties])
  → TextBox
Creates a new TextBox
layer Layer The layer on which to create the TextBox. (Optional)
at LocationOptions The location at which to insert the TextBox 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 TextBox (Optional)
anyItem(
)
  → TextBox
Returns any TextBox in the collection.
count(
)
  → number
Displays the number of elements in the TextBox.
everyItem(
)
  → TextBox
Returns every TextBox in the collection.
firstItem(
)
  → TextBox
Returns the first TextBox in the collection.
item(
index)
  → TextBox
Returns the TextBox with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → TextBox
Returns the TextBox with the specified ID.
id number The ID.
itemByName(
name)
  → TextBox
Returns the TextBox with the specified name.
name string The name.
itemByRange(
from, to)
  → TextBox
Returns the TextBoxes within the specified range.
from The TextBox, index, or name at the beginning of the range. Can accept: TextBox, Long Integer or String.
to The TextBox, index, or name at the end of the range. Can accept: TextBox, Long Integer or String.
lastItem(
)
  → TextBox
Returns the last TextBox in the collection.
middleItem(
)
  → TextBox
Returns the middle TextBox in the collection.
nextItem(
obj)
  → TextBox
Returns the TextBox whose index follows the specified TextBox in the collection.
obj TextBox The TextBox whose index comes before the desired TextBox.
previousItem(
obj)
  → TextBox
Returns the TextBox with the index previous to the specified index.
obj TextBox The index of the TextBox that follows the desired TextBox.
toSource(
)
  → string
Generates a string which, if executed, will return the TextBox.