A text path.
text path elements
| Name | Refer to By |
|---|---|
| characters | by numeric index, as a range of elements, before/after another element, satisfying a test |
| insertion points | by numeric index, as a range of elements, before/after another element, satisfying a test |
| lines | by numeric index, as a range of elements, before/after another element, satisfying a test |
| paragraphs | by numeric index, as a range of elements, before/after another element, satisfying a test |
| text columns | by numeric index, as a range of elements, before/after another element, satisfying a test |
| texts | by numeric index, as a range of elements, before/after another element, satisfying a test |
| text style ranges | by numeric index, as a range of elements, before/after another element, satisfying a test |
| words | by numeric index, as a range of elements, before/after another element, satisfying a test |
text path properties
| Property | Type | Access | Description |
|---|---|---|---|
| center bracket | fixed | read | The center bracket. |
| class | integer | read | The class descriptor type. |
| contents | string, text frame contents enumeration, special characters enumeration | r/w | The text contents. |
| end bracket | fixed | r/w | The end bracket. |
| end text frame | text frame, text path | read | The last text frame in the thread as TextFrame or TextPath. |
| flip path effect | flip values enumeration | r/w | The flip path effect. |
| id | integer | read | A unique number identifying the object. |
| index | integer | read | Index of the object within its parent object. |
| label | string | r/w | A label that can be set to any string. |
| next text frame | text frame, text path | r/w | The next text frame in the thread as TextFrame or TextPath. |
| object reference | object | read | An object reference for this object. |
| overflows | boolean | read | If true, the object contains overset text. |
| parent | object | read | The parent of the object. |
| parent story | story | read | The story containing the object. |
| path alignment | path type alignments enumeration | r/w | The path alignment. |
| path effect | text path effects enumeration | r/w | The path effect. |
| path spacing | integer | r/w | The path spacing. |
| previous text frame | text frame, text path | r/w | The previous text frame in the thread as TextFrame or TextPath. |
| properties | record | r/w | Property that allows setting of several properties at the same time. |
| start bracket | fixed | r/w | The start bracket. |
| start text frame | text frame, text path | read | The first text frame in the thread as TextFrame or TextPath. |
| text alignment | text type alignments enumeration | r/w | The text alignment. |
| text frame index | integer | read | Index of the text frame in its thread of linked frames. |
text path methods
| Method | Returns | Description |
|---|---|---|
| delete | Nothing | Delete the object. |
| extract label | string | Gets the content of the label associated with the specified key (name). |
| insert label | Nothing | Sets the content of the label associated with the specified key (name), creating the label if it does not already exist. |
| search | list 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. |