TextPaths

A collection of text paths.

Methods

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

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

TextPathanyItem ()
Returns any TextPath in the collection.

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

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

TextPathfirstItem ()
Returns the first TextPath in the collection.

TextPathitem (index:
any)
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.

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

Parameter Type Description
id number The ID.

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

Parameter Type Description
name string The name.

Array of TextPathitemByRange (from:
any, to:
any)
Returns the TextPaths within the specified range.

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

TextPathlastItem ()
Returns the last TextPath in the collection.

TextPathmiddleItem ()
Returns the middle TextPath in the collection.

TextPathnextItem (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.

TextPathpreviousItem (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:

GraphicLine.textPaths
Oval.textPaths
PageItem.textPaths
Polygon.textPaths
Rectangle.textPaths
TextFrame.textPaths

Leave a Comment

Previous post:

Next post: