TextPath

A text object that is on a path.

Properties

Property	Type	Access	Description
centerBracket	number	readonly	The halfway point between the start bracket and the end bracket.
characters	Characters	readonly	A collection of characters.
contents	any	r/w	The contents of the text frame. Can return: String, TextFrameContents enumerator or SpecialCharacters enumerator.
endBracket	number	r/w	The end of the type on a path. Note: Additional text becomes overset text unless the text is linked to another path or text frame.
endTextFrame	any	readonly	The last text frame in the thread. Can return: TextFrame or TextPath.
flipPathEffect	FlipValues : NOT_FLIPPED FLIPPED UNDEFINED_FLIP_VALUE	r/w	The flip effect applied to the type on a path.
id	number	readonly	The unique ID of the TextPath.
index	number	readonly	The index of the TextPath within its containing object.
insertionPoints	InsertionPoints	readonly	A collection of insertion points.
label	string	r/w	A property that can be set to any string.
lines	Lines	readonly	A collection of lines.
nextTextFrame	any	r/w	The next text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator.
overflows	bool	readonly	If true, the TextPath has overset text.
paragraphs	Paragraphs	readonly	A collection of paragraphs.
parent	any	readonly	The parent of the TextPath (a PageItem, Oval, Rectangle, GraphicLine, TextFrame or Polygon).
parentStory	Story	readonly	The story that contains the TextPath.
pathAlignment	PathTypeAlignments : TOP_PATH_ALIGNMENT BOTTOM_PATH_ALIGNMENT CENTER_PATH_ALIGNMENT	r/w	The alignment of the type on a path.
pathEffect	TextPathEffects : RAINBOW_PATH_EFFECT SKEW_PATH_EFFECT RIBBON_PATH_EFFECT STAIR_STEP_PATH_EFFECT GRAVITY_PATH_EFFECT	r/w	The effect applied to the type on a path.
pathSpacing	number	r/w	The spacing applied to the type on a path.
previousTextFrame	any	r/w	The previous text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator.
properties	Object	r/w	A property that allows setting of several properties at the same time.
startBracket	number	r/w	The location of the start of the type on the path, expressed in points. Note: 0 is the first point on the path.
startTextFrame	any	readonly	The first text frame in the thread. Can return: TextFrame or TextPath.
textAlignment	TextTypeAlignments : ASCENDER_TEXT_ALIGNMENT DESCENDER_TEXT_ALIGNMENT CENTER_TEXT_ALIGNMENT BASELINE_TEXT_ALIGNMENT ABOVE_RIGHT_EM_BOX_TEXT_ALIGNMENT BELOW_LEFT_EM_BOX_TEXT_ALIGNMENT ABOVE_RIGHT_ICF_BOX_TEXT_ALIGNMENT BELOW_LEFT_ICF_BOX_TEXT_ALIGNMENT	r/w	The alignment applied to the type on a path.
textColumns	TextColumns	readonly	A collection of text columns.
textFrameIndex	number	readonly	The index of the text frame within the thread of linked frames.
texts	Texts	readonly	A collection of text objects.
textStyleRanges	TextStyleRanges	readonly	A collection of text style ranges.
words	Words	readonly	A collection of words.

Methods

Array of TextchangeGlyph ([reverseOrder:
bool])
Finds glyphs that match the find what value and replaces the glyphs with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of TextchangeGrep ([reverseOrder:
bool])
Finds text that matches the find what value and replaces the text with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of TextchangeText ([reverseOrder:
bool])
Finds text that matches the find what value and replaces the text with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

string extractLabel (key:
string)
Gets the label value associated with the specified key.

Parameter	Type	Description
key	string	The key.

Array of TextfindGlyph ([reverseOrder:
bool])
Finds glyphs that match the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of TextfindGrep ([reverseOrder:
bool])
Finds text that matches the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of TextfindText ([reverseOrder:
bool])
Finds text that matches the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of TextPathgetElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	string	The key.
value	string	The value.

void remove ()
Deletes the TextPath.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

TextPaths.previousItem (

obj:
TextPath )

TextPaths.nextItem (

obj:
TextPath )

Returned by:

Array of TextPath TextPath .getElements (

)

TextPath TextPaths.add (
[withProperties:
Object]
)

TextPath TextPaths.anyItem (

)

Array of TextPath TextPaths.everyItem (

)

TextPath TextPaths.firstItem (

)

TextPath TextPaths.item (
index:
any
)

TextPath TextPaths.itemByID (
id:
number
)

TextPath TextPaths.itemByName (
name:
string
)

Array of TextPath TextPaths.itemByRange (
from:
any, to:
any
)

TextPath TextPaths.lastItem (

)

TextPath TextPaths.middleItem (

)

TextPath TextPaths.nextItem (
obj:
TextPath
)

TextPath TextPaths.previousItem (
obj:
TextPath
)