A text path.
| Property |
Type |
Access |
Description |
| centerBracket |
Real |
read |
The center bracket. |
| characters |
Characters |
read |
The characters of the object. |
| contents |
String, TextFrameContents enumeration, SpecialCharacters enumeration (see table at end of chapter) |
r/w |
The text contents. |
| endBracket |
Real |
r/w |
The end bracket. |
| endTextFrame |
TextFrame, TextPath |
read |
The last text frame in the thread as TextFrame or TextPath. |
|
| flipPathEffect |
FlipValues enumeration |
r/w |
The flip path effect. |
| id |
Long |
read |
A unique number identifying the object. |
| index |
Long |
read |
Index of the object within its parent object. |
| insertionPoints |
InsertionPoints |
read |
The insertion points in the object. |
| label |
String |
r/w |
A label that can be set to any string. |
| lines |
Lines |
read |
The lines of text in the object. |
| nextTextFrame |
TextFrame, TextPath |
r/w |
The next text frame in the thread as TextFrame or TextPath. |
| overflows |
Boolean |
read |
If true, the object contains overset text. |
| paragraphs |
Paragraphs |
read |
The paragraphs contained by the object. |
| parent |
Object |
read |
The parent of the object. |
| parentStory |
Story |
read |
The story containing the object. |
| pathAlignment |
PathTypeAlignments enumeration |
r/w |
The path alignment. |
| pathEffect |
TextPathEffects enumeration |
r/w |
The path effect. |
| pathSpacing |
Long |
r/w |
The path spacing. |
| previousTextFrame |
TextFrame, TextPath |
r/w |
The previous text frame in the thread as TextFrame or TextPath. |
| properties |
An array of property names and values |
r/w |
Property that allows setting of several properties at the same time. |
| startBracket |
Real |
r/w |
The start bracket. |
| startTextFrame |
TextFrame, TextPath |
read |
The first text frame in the thread as TextFrame or TextPath. |
|
| textAlignment |
TextTypeAlignments enumeration |
r/w |
The text alignment. |
| textColumns |
TextColumns |
read |
The text columns contained by the object. |
| textFrameIndex |
Long |
read |
Index of the text frame in its thread of linked frames. |
| texts |
Texts |
read |
The texts contained by the object. |
| textStyleRanges |
TextStyleRanges |
read |
The text style ranges contained by the object. |
| words |
Words |
read |
The words contained by the object. |
| Method |
Returns |
Description |
| extractLabel |
String |
Gets the content of the label associated with the specified key (name). |
| getElements |
Array of Objects |
Resolve the object specifier. |
| insertLabel |
Nothing |
Sets the content of the label associated with the specified key (name), creating the label if it does not already exist. |
| remove |
Nothing |
Delete the object. |
|
| search |
Array of Texts |
Searches for text and returns a list of text objects matching the search string and/or formatting specified by the find preferences. Search can also replace the text and/or formatting. This command corresponds to InDesign’s Find/Change feature. |
| toSource |
String |
Generate JavaScript source that, if executed, will return the specified objects. |
| toSpecifier |
String |
Retrieve the object specifier. |