Adds an event listener.
Object
TextPath
A text object that is on a path.
Hierarchy
EPSText | EndnoteTextFrame | GraphicLine | Oval | Polygon | Rectangle | SplineItem | TextFrame
TextPath
Character | InsertionPoint | Line | Paragraph | Text | TextColumn | TextStyleRange | Word
Properties
| Name | Type | Access | Description |
|---|---|---|---|
| Number | readonly | The halfway point between the start bracket and the end bracket. | |
| Characters |
readonly | A collection of characters. | |
| String | TextFrameContents | SpecialCharacters | read/write | The contents of the text frame. Can return: String, TextFrameContents enumerator or SpecialCharacters enumerator. | |
| Number | read/write | 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. | |
| TextFrame | TextPath | readonly | The last text frame in the thread. Can return: TextFrame or TextPath. | |
| EventListeners |
readonly | A collection of event listeners. | |
| Events |
readonly | A collection of events. | |
| FlipValues | read/write | The flip effect applied to the type on a path. | |
| Number | readonly | The unique ID of the TextPath. | |
| Number | readonly | The index of the TextPath within its containing object. | |
| InsertionPoints |
readonly | A collection of insertion points. | |
| Boolean | readonly | Returns true if the object specifier resolves to valid objects. | |
| String | read/write | A property that can be set to any string. | |
| Lines |
readonly | A collection of lines. | |
| String | read/write | The name of the TextPath; this is an alias to the TextPath's label property. | |
| NothingEnum | TextFrame | TextPath | read/write | The next text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator. | |
| Boolean | readonly | If true, the story has overset text. | |
| Paragraphs |
readonly | A collection of paragraphs. | |
| EndnoteTextFrame | GraphicLine | Oval | Polygon | Rectangle | TextFrame | EPSText | SplineItem | readonly | The parent of the TextPath (a SplineItem, Polygon, GraphicLine, Rectangle, Oval, TextFrame, EndnoteTextFrame or EPSText). | |
| Story | readonly | The story that contains the text. | |
| PathTypeAlignments | read/write | The alignment of the type on a path. | |
| TextPathEffects | read/write | The effect applied to the type on a path. | |
| Number | read/write | The spacing applied to the type on a path. | |
| NothingEnum | TextFrame | TextPath | read/write | The previous text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator. | |
| Object | read/write | A property that allows setting of several properties at the same time. | |
| Number | read/write | The location of the start of the type on the path, expressed in points. Note: 0 is the first point on the path. | |
| TextFrame | TextPath | readonly | The first text frame in the thread. Can return: TextFrame or TextPath. | |
| TextTypeAlignments | read/write | The alignment applied to the type on a path. | |
| TextColumns |
readonly | A collection of text columns. | |
| Number | readonly | The index of the text frame within the story. | |
| TextStyleRanges |
readonly | A collection of text style ranges. | |
| Texts |
readonly | A collection of text objects. | |
| Words |
readonly | A collection of words. |
Events
| Name | Description |
|---|---|
| Dispatched after a TextPath is placed. This event bubbles. This event is not cancelable. | |
| Dispatched before a TextPath is placed. This event bubbles. This event is cancelable. |
Methods
→ Text[]
Finds glyphs that match the find what value and replaces the glyphs with the change to value.
→ Text[]
Finds text that matches the find what value and replaces the text with the change to value.
→ Text[]
Finds text that matches the find what value and replaces the text with the change to value.
→ Text[]
Finds text that matches the find character type value and replaces the text with the change character type value.
→ String
Gets the label value associated with the specified key.
→ Text[]
Finds glyphs that match the find what value.
→ Text[]
Finds text that matches the find what value.
→ Text[]
Finds text that matches the find what value.
→ Text[]
Finds text that matches the find character type value.
→ TextPath[]
Resolves the object specifier, creating an array of object references.
→ void
Sets the label to the value associated with the specified key.
→ void
Deletes the TextPath.
→ Boolean
Removes the event listener.
→ String
Generates a string which, if executed, will return the TextPath.
→ String
Retrieves the object specifier.
Object of 23
Properties elsewhere that hold a TextPath.
Character.parentEndnoteTextFrame.endTextFrameEndnoteTextFrame.nextTextFrameEndnoteTextFrame.previousTextFrameEndnoteTextFrame.startTextFrameEvent.parentEventListener.parentInsertionPoint.parentLine.parentMutationEvent.parentParagraph.parentText.parentTextColumn.parentTextFrame.endTextFrameTextFrame.nextTextFrameTextFrame.previousTextFrameTextFrame.startTextFrameTextPath.endTextFrameTextPath.nextTextFrameTextPath.previousTextFrameTextPath.startTextFrameTextStyleRange.parentWord.parent
Parameter of 3
Method parameters that accept a TextPath.
Return 14
Methods that return a TextPath.