A collection of text paths.
Element
character
insertion point
line
paragraph
text
text column
text style range
word
text path Properties
| Property | Type | Access | Description |
|---|---|---|---|
| center bracket | fixed | read | The halfway point between the start bracket and the end bracket. |
| class | type class | read | The class descriptor type. |
| contents | anything | r/w | The contents of the text frame. Can return: string, placeholder text or auto page number/next page number/previous page number/section marker/bullet character/copyright symbol/degree symbol/ellipsis character/forced line break/paragraph symbol/register… |
| end bracket | fixed | r/w | 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. |
| end text frame | reference | read | The last text frame in the thread. Can return: text frame or text path. |
| flip path effect | not flipped, flipped, undefined flip value, |
r/w | The flip effect applied to the type on a path. |
| id | integer | read | The unique ID of the text path. |
| index | integer | read | The index of the text path within its containing object. |
| label | string | r/w | A property that can be set to any string. |
| next text frame | reference | r/w | The next text frame in the thread. Can return: text frame or text path. Can also accept: nothing. |
| object reference | text path | read | An object reference for the text path. |
| overflows | boolean | read | If true, the text path has overset text. |
| parent | reference | read | The parent of the text path (a page item, oval, rectangle, graphic line, text frame or polygon). Can return: page item, oval, rectangle, graphic line, text frame or polygon. |
| parent story | story | read | The story that contains the text path. |
| path alignment | top path alignment, bottom path alignment, center path alignment, |
r/w | The alignment of the type on a path. |
| path effect | rainbow path effect, skew path effect, ribbon path effect, stair step path effect, gravity path effect, |
r/w | The effect applied to the type on a path. |
| path spacing | integer | r/w | The spacing applied to the type on a path. |
| previous text frame | reference | r/w | The previous text frame in the thread. Can return: text frame or text path. Can also accept: nothing. |
| properties | record | r/w | A property that allows setting of several properties at the same time. |
| start bracket | fixed | r/w | The location of the start of the type on the path, expressed in points. Note: 0 is the first point on the path. |
| start text frame | reference | read | The first text frame in the thread. Can return: text frame or text path. |
| text alignment | ascender text alignment, descender text alignment, center text alignment, baseline text alignment, above right em box text alignment, below left em box text alignment, above right icf box text alignment, below left icf box text alignment, |
r/w | The alignment applied to the type on a path. |
| text frame index | integer | read | The index of the text frame within the thread of linked frames. |