K4 InDesign Javascript API Documentation

TextTabStop

A tab stop.

Instance Properties

Name Description Access
alignment TabStopAlignment The tab stop alignment. read-write
alignmentCharacter string The tab stop alignment character. Note: Valid when alignment is character align. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
index number The index of the TabStop within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
leader string The tab stop leader. read-write
parent The parent of the TabStop (a TextDefault, Paragraph, ParagraphStyle, Text, InsertionPoint, TextStyleRange, TextColumn, Line, Word, Character, Story or XmlStory). read-only
position Measurement Unit (Number or String)=any The position of the tab stop. read-write
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → TabStop
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → TabStop
Resolves the object specifier, creating an array of object references.
remove(
)
Deletes the TabStop.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the TabStop.
toSpecifier(
)
  → string
Retrieves the object specifier.