Adobe InDesign CS2 (4.0) Object Model JS: TabStops

InDesign CS2

Class

TabStops

 A collection of tab stops.

QuickLinks

add, anyItem, count, everyItem, firstItem, item, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

TabStop add ([withProperties: Object])
Creates a new TabStop.

ParameterTypeDescription
withPropertiesObjectInitial values for properties of the new TabStop (Optional)

TabStop anyItem ()
Returns any TabStop in the collection.

number count ()
Displays the number of elements in the TabStop.

Array of TabStop everyItem ()
Returns every TabStop in the collection.

TabStop firstItem ()
Returns the first TabStop in the collection.

TabStop item (index: any)
Returns the TabStop with the specified index or name.

ParameterTypeDescription
indexLong
String
The index or name. Can accept: Long or String.

TabStop itemByName (name: string)
Returns the TabStop with the specified name.

ParameterTypeDescription
namestringThe name.

Array of TabStop itemByRange (from: any, to: any)
Returns the TabStops within the specified range.

ParameterTypeDescription
fromLong
String
TabStop
The TabStop, index, or name at the beginning of the range. Can accept: TabStop, Long or String.
toLong
String
TabStop
The TabStop, index, or name at the end of the range. Can accept: TabStop, Long or String.

TabStop lastItem ()
Returns the last TabStop in the collection.

TabStop middleItem ()
Returns the middle TabStop in the collection.

TabStop nextItem (obj: TabStop)
Returns the TabStop whose index follows the specified TabStop in the collection.

ParameterTypeDescription
objTabStopThe TabStop whose index comes before the desired TabStop.

TabStop previousItem (obj: TabStop)
Returns the TabStop with the index previous to the specified index.

ParameterTypeDescription
objTabStopThe index of the TabStop that follows the desired TabStop.

string toSource ()
Generates a string which, if executed, will return the TabStop.

Element of

Character.tabStops

InsertionPoint.tabStops

Line.tabStops

Paragraph.tabStops

ParagraphStyle.tabStops

Story.tabStops

Text.tabStops

TextColumn.tabStops

TextDefault.tabStops

TextStyleRange.tabStops

Word.tabStops

Jongware, 27-Jun-2010 v3.0.3dContents :: Index