Class

TextPaths

A collection of text paths.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

Property	Type	Access	Description
length	number	readonly	The number of objects in the collection.

Methods

Instances

TextPath [] (index: number)
Returns the TextPath with the specified index.

Parameter	Type	Description
index	number	The index.

TextPath add ([withProperties: Object])
Creates a new TextPath.

Parameter	Type	Description
withProperties	Object	Initial values for properties of the new TextPath (Optional)

TextPath anyItem ()
Returns any TextPath in the collection.

number count ()
Displays the number of elements in the TextPath.

Array of TextPath everyItem ()
Returns every TextPath in the collection.

TextPath firstItem ()
Returns the first TextPath in the collection.

TextPath item (index: varies)
Returns the TextPath with the specified index or name.

Parameter	Type	Description
index	Long Integer String	The index or name. Can accept: Long Integer or String.

TextPath itemByID (id: number)
Returns the TextPath with the specified ID.

Parameter	Type	Description
id	number	The ID.

TextPath itemByName (name: string)
Returns the TextPath with the specified name.

Parameter	Type	Description
name	string	The name.

Array of TextPath itemByRange (from: varies, to: varies)
Returns the TextPaths within the specified range.

Parameter	Type	Description
from	Long Integer String TextPath	The TextPath, index, or name at the beginning of the range. Can accept: TextPath, Long Integer or String.
to	Long Integer String TextPath	The TextPath, index, or name at the end of the range. Can accept: TextPath, Long Integer or String.

TextPath lastItem ()
Returns the last TextPath in the collection.

TextPath middleItem ()
Returns the middle TextPath in the collection.

TextPath nextItem (obj: TextPath)
Returns the TextPath whose index follows the specified TextPath in the collection.

Parameter	Type	Description
obj	TextPath	The TextPath whose index comes before the desired TextPath.

TextPath previousItem (obj: TextPath)
Returns the TextPath with the index previous to the specified index.

Parameter	Type	Description
obj	TextPath	The index of the TextPath that follows the desired TextPath.

string toSource ()
Generates a string which, if executed, will return the TextPath.

Element of

Character.parentTextFrames

EPSText.textPaths

GraphicLine.textPaths

InsertionPoint.parentTextFrames

Line.parentTextFrames

Oval.textPaths

Paragraph.parentTextFrames

Polygon.textPaths

Rectangle.textPaths

SplineItem.textPaths

Story.textContainers

Text.parentTextFrames

TextColumn.parentTextFrames

TextFrame.textPaths

TextStyleRange.parentTextFrames

Word.parentTextFrames

XmlStory.textContainers

Jongware, 28-Apr-2012 v3.0.3i

Contents :: Index