TextPath
A text path.
TextPath Properties
| Property |
Type |
Access |
Description |
| CenterBracket |
Double |
read |
The center bracket. |
| Characters |
Characters |
read |
The characters of the object. |
| Contents |
String, idTextFrameContents enumeration, idSpecialCharacters enumeration (see table at end of chapter) |
r/w |
The text contents. |
| EndBracket |
Double |
r/w |
The end bracket. |
| EndTextFrame |
TextFrame, TextPath |
read |
The last text frame in the thread as TextFrame or TextPath. |
| FlipPathEffect |
idFlipValues 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 |
idPathTypeAlignments enumeration |
r/w |
The path alignment. |
|
| PathEffect |
idTextPathEffects 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. |
| StartBracket |
Double |
r/w |
The start bracket. |
| StartTextFrame |
TextFrame, TextPath |
read |
The first text frame in the thread as TextFrame or TextPath. |
| TextAlignment |
idTextTypeAlignments 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. |
TextPath Methods
| Method |
Returns |
Description |
| Delete |
Nothing |
Deletes the object. |
| ExtractLabel |
String |
Gets the content of the label associated with the specified key (name). |
|
| InsertLabel |
Nothing |
Sets the content of the label associated with the specified key (name), creating the label if it does not already exist. |
| 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. |