TextFrameItems
See also TextFrameItem.
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | int | readonly | Number of elements in the collection. |
| parent | Object | readonly | The object's container. |
| typename | string | readonly | The class name of the object. |
Methods
Class
TextFrameItem add ()
Create a point text frame item.
TextFrameItem areaText (textPath:
PathItem[, orientation:
TextOrientation=TextOrientation.HORIZONTAL][, baseFrame:
TextFrameItem][, postFix:
bool=true])
Create an area text frame item.
| Parameter | Type | Description |
|---|---|---|
| textPath | PathItem | The path item associated with the text frame. |
| orientation | TextOrientation: TextOrientation.HORIZONTAL TextOrientation.VERTICAL | The orientation of the text. (default: TextOrientation.HORIZONTAL) (Optional) |
| baseFrame | TextFrameItem | The base text frame if it has one. (Optional) |
| postFix | bool | Whether to postfix/prefix the new text frame to the specified base text frame. (default: true) (Optional) |
TextFrameItem pathText (textPath:
PathItem[, startTValue:
number=0.0][, endTValue:
number=0.0][, orientation:
TextOrientation=TextOrientation.HORIZONTAL][, baseFrame:
TextFrameItem][, postFix:
bool=true])
Create an on-path text frame item.
| Parameter | Type | Description |
|---|---|---|
| textPath | PathItem | The path item associated with the text frame. |
| startTValue | number | The start position of text along a path, as a value relative to the path's segments (path text only) (default: 0.0) (Optional) |
| endTValue | number | The end position of text along a path, as a value relative to the path's segments (path text only) (default: 0.0) (Optional) |
| orientation | TextOrientation: TextOrientation.HORIZONTAL TextOrientation.VERTICAL | The orientation of the text. (default: TextOrientation.HORIZONTAL) (Optional) |
| baseFrame | TextFrameItem | The base text frame if it has one. (Optional) |
| postFix | bool | Whether to postfix/prefix the new text frame to the specified base text frame. (default: true) (Optional) |
TextFrameItem pointText (anchor:
Point[, orientation:
TextOrientation=TextOrientation.HORIZONTAL])
Create a point text frame item.
| Parameter | Type | Description |
|---|---|---|
| anchor | Point | The position (coordinates) of the anchor point. |
| orientation | TextOrientation: TextOrientation.HORIZONTAL TextOrientation.VERTICAL | The orientation of the text. (default: TextOrientation.HORIZONTAL) (Optional) |
Instances
TextFrameItem getByName (name:
string)
Get the first element in the collection with the provided name.
| Parameter | Type | Description |
|---|---|---|
| name | string |
Element of
Document.textFrames
GroupItem.textFrames
Layer.textFrames
Story.textFrames
| Jongware, 25-Nov-2012 v3.0.3i | Contents :: Index |