K4 InDesign Javascript API Documentation

TextTabStops

A collection of tab stops.

Instance Properties

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

Methods

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