K4 InDesign Javascript API Documentation

TextInsertionPoints

A collection of insertion points.

Instance Properties

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

Methods

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