TextFrameItems

Methods:

add, areaText, getByName, pathText, pointText, removeAll

Property Listing

Property	Type	Access	Description
length	Int	readonly	Number of elements in the collection.
parent		readonly	The object's container.
typename	String	readonly	The class name of the object.

Method Listing

TextFrameItem add ()

Create a point text frame item.

TextFrameItem areaText (textPath:PathItem, [orientation:TextOrientation=TextOrientation], [baseFrame:TextFrameItem], [postFix:Boolean=Boolean])

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)
baseFrame	TextFrameItem	The base text frame if it has one.
postFix	Boolean	Whether to postfix/prefix the new text frame to the specified base text frame. (default: true)

TextFrameItem getByName (name:String)

Get the first element in the collection with the provided name.

Parameter	Type	Description
name	String

TextFrameItem pathText (textPath:PathItem, [startTValue:Number=Number], [endTValue:Number=Number], [orientation:TextOrientation=TextOrientation], [baseFrame:TextFrameItem], [postFix:Boolean=Boolean])

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)
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)
orientation	TextOrientation TextOrientation.HORIZONTAL TextOrientation.VERTICAL	The orientation of the text. (default: TextOrientation.HORIZONTAL)
baseFrame	TextFrameItem	The base text frame if it has one.
postFix	Boolean	Whether to postfix/prefix the new text frame to the specified base text frame. (default: true)

TextFrameItem pointText (anchor:Point, [orientation:TextOrientation=TextOrientation])

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)

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)

undefined removeAll ()

Deletes all elements.

Object of

Document.textFrames

GroupItem.textFrames

Layer.textFrames

Story.textFrames