TextPaths

A collection of text paths.

Methods:

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

Property Listing

Property

Type

Access

Description

length

Number

readonly

The number of objects in the collection.

Method Listing

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.

TextPath everyItem ()

Returns every TextPath in the collection.

TextPath firstItem ()

Returns the first TextPath in the collection.

TextPath item (index:Varies LongInteger String)

Returns the TextPath with the specified index or name.

Parameter

Type

Description

index

LongInteger

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.

TextPath itemByRange (from:Varies LongInteger TextPath String, to:Varies LongInteger TextPath String)

Returns the TextPaths within the specified range.

Parameter

Type

Description

from

LongInteger

TextPath

String

The TextPath, index, or name at the beginning of the range. Can accept: TextPath, Long Integer or String.

to

LongInteger

TextPath

String

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.

Object of

Oval.textPaths

Rectangle.textPaths

GraphicLine.textPaths

Polygon.textPaths

SplineItem.textPaths

EPSText.textPaths

TextFrame.textPaths

EndnoteTextFrame.textPaths

Text.parentTextFrames

Character.parentTextFrames

Word.parentTextFrames

Line.parentTextFrames

TextColumn.parentTextFrames

Paragraph.parentTextFrames

TextStyleRange.parentTextFrames

InsertionPoint.parentTextFrames

Story.textContainers

XmlStory.textContainers