K4 InDesign Javascript API Documentation

TextTextPath

A text object that is on a path.

Static Properties

Name Description
AFTER_PLACE = "afterPlace" string Dispatched after a TextPath is placed. This event bubbles. This event is not cancelable.
BEFORE_PLACE = "beforePlace" string Dispatched before a TextPath is placed. This event bubbles. This event is cancelable.

Instance Properties

Name Description Access
centerBracket number The halfway point between the start bracket and the end bracket. read-only
characters Characters A collection of characters. read-only
contents The contents of the text frame. Can return: String, TextFrameContents enumerator or SpecialCharacters enumerator. read-write
endBracket number The end of the type on a path. Note: Additional text becomes overset text unless the text is linked to another path or text frame. read-write
endTextFrame The last text frame in the thread. Can return: TextFrame or TextPath. read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
flipPathEffect FlipValues The flip effect applied to the type on a path. read-write
id number The unique ID of the TextPath. read-only
index number The index of the TextPath within its containing object. read-only
insertionPoints InsertionPoints A collection of insertion points. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
lines Lines A collection of lines. read-only
name string The name of the TextPath; this is an alias to the TextPath's label property. read-write
nextTextFrame The next text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator. read-write
overflows bool If true, the story has overset text. read-only
paragraphs Paragraphs A collection of paragraphs. read-only
parent The parent of the TextPath (a SplineItem, Polygon, GraphicLine, Rectangle, Oval, TextFrame, EndnoteTextFrame or EPSText). read-only
parentStory Story The story that contains the text. read-only
pathAlignment PathTypeAlignments The alignment of the type on a path. read-write
pathEffect TextPathEffects The effect applied to the type on a path. read-write
pathSpacing number The spacing applied to the type on a path. read-write
previousTextFrame The previous text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator. read-write
properties Object A property that allows setting of several properties at the same time. read-write
startBracket number The location of the start of the type on the path, expressed in points. Note: 0 is the first point on the path. read-write
startTextFrame The first text frame in the thread. Can return: TextFrame or TextPath. read-only
textAlignment TextTypeAlignments The alignment applied to the type on a path. read-write
textColumns TextColumns A collection of text columns. read-only
textFrameIndex number The index of the text frame within the story. read-only
textStyleRanges TextStyleRanges A collection of text style ranges. read-only
texts Texts A collection of text objects. read-only
words Words A collection of words. read-only

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
changeGlyph(
[reverseOrder])
  → Text
changeGrep(
[reverseOrder])
  → Text
changeText(
[reverseOrder])
  → Text
changeTransliterate(
[reverseOrder])
  → Text
extractLabel(
key)
  → string
findGlyph(
[reverseOrder])
  → Text
findGrep(
[reverseOrder])
  → Text
findText(
[reverseOrder])
  → Text
findTransliterate(
[reverseOrder])
  → Text
getElements(
)
  → TextPath
insertLabel(
key, value)
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)
changeGlyph(
[reverseOrder])
  → Text
Finds glyphs that match the find what value and replaces the glyphs with the change to value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
changeGrep(
[reverseOrder])
  → Text
Finds text that matches the find what value and replaces the text with the change to value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
changeText(
[reverseOrder])
  → Text
Finds text that matches the find what value and replaces the text with the change to value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
changeTransliterate(
[reverseOrder])
  → Text
Finds text that matches the find character type value and replaces the text with the change character type value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
findGlyph(
[reverseOrder])
  → Text
Finds glyphs that match the find what value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
findGrep(
[reverseOrder])
  → Text
Finds text that matches the find what value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
findText(
[reverseOrder])
  → Text
Finds text that matches the find what value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
findTransliterate(
[reverseOrder])
  → Text
Finds text that matches the find character type value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
getElements(
)
  → TextPath
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
remove(
)
Deletes the TextPath.
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 TextPath.
toSpecifier(
)
  → string
Retrieves the object specifier.