Adobe Illustrator CS5 Type Library JS: TextFrameItems

Illustrator CS5

Class

TextFrameItems

 A collection of text frame items.

QuickLinks

add, areaText, getByName, pathText, pointText, removeAll

Hierarchy

Object
TextFrameItems

Properties

PropertyTypeAccessDescription
lengthint readonlyNumber of elements in the collection.
parentObject readonlyThe object's container.
typenamestring readonlyThe 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.

ParameterTypeDescription
textPathPathItemThe path item associated with the text frame.
orientationTextOrientation:
TextOrientation.HORIZONTAL
TextOrientation.VERTICAL
The orientation of the text. (default: TextOrientation.HORIZONTAL) (Optional)
baseFrameTextFrameItemThe base text frame if it has one. (Optional)
postFixboolWhether 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.

ParameterTypeDescription
textPathPathItemThe path item associated with the text frame.
startTValuenumberThe start position of text along a path, as a value relative to the path's segments (path text only) (default: 0.0) (Optional)
endTValuenumberThe end position of text along a path, as a value relative to the path's segments (path text only) (default: 0.0) (Optional)
orientationTextOrientation:
TextOrientation.HORIZONTAL
TextOrientation.VERTICAL
The orientation of the text. (default: TextOrientation.HORIZONTAL) (Optional)
baseFrameTextFrameItemThe base text frame if it has one. (Optional)
postFixboolWhether 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.

ParameterTypeDescription
anchorPointThe position (coordinates) of the anchor point.
orientationTextOrientation:
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.

ParameterTypeDescription
namestring

void removeAll ()
Deletes all elements.

Element of

Document.textFrames

GroupItem.textFrames

Layer.textFrames

Story.textFrames

Jongware, 27-Jun-2010 v3.0.3dContents :: Index