Adobe InDesign CS6 (8.0) Object Model JS: TextPath

InDesign CS6

previous page next page

Class

TextPath

A text object that is on a path.

QuickLinks

addEventListener, changeGlyph, changeGrep, changeText, changeTransliterate, extractLabel, findGlyph, findGrep, findText, findTransliterate, getElements, insertLabel, remove, removeEventListener, toSource, toSpecifier

Hierarchy

TextPath

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	SpecialCharacters String TextFrameContents	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	TextFrame TextPath	readonly	The last text frame in the thread. Can return: TextFrame or TextPath.
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
flipPathEffect	FlipValues: FlipValues.NOT_FLIPPED FlipValues.FLIPPED FlipValues.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.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
label	string	r/w	A property that can be set to any string.
lines	Lines	readonly	A collection of lines.
name	string	r/w	The name of the TextPath; this is an alias to the TextPath's label property.
nextTextFrame	NothingEnum TextFrame TextPath	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 story has overset text.
paragraphs	Paragraphs	readonly	A collection of paragraphs.
parent	EPSText GraphicLine Oval Polygon Rectangle SplineItem TextFrame	readonly	The parent of the TextPath (a SplineItem, Polygon, GraphicLine, Rectangle, Oval, TextFrame or EPSText).
parentStory	Story	readonly	The story that contains the text.
pathAlignment	PathTypeAlignments: PathTypeAlignments.TOP_PATH_ALIGNMENT PathTypeAlignments.BOTTOM_PATH_ALIGNMENT PathTypeAlignments.CENTER_PATH_ALIGNMENT	r/w	The alignment of the type on a path.
pathEffect	TextPathEffects: TextPathEffects.RAINBOW_PATH_EFFECT TextPathEffects.SKEW_PATH_EFFECT TextPathEffects.RIBBON_PATH_EFFECT TextPathEffects.STAIR_STEP_PATH_EFFECT TextPathEffects.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	NothingEnum TextFrame TextPath	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	TextFrame TextPath	readonly	The first text frame in the thread. Can return: TextFrame or TextPath.
textAlignment	TextTypeAlignments: TextTypeAlignments.ASCENDER_TEXT_ALIGNMENT TextTypeAlignments.DESCENDER_TEXT_ALIGNMENT TextTypeAlignments.CENTER_TEXT_ALIGNMENT TextTypeAlignments.BASELINE_TEXT_ALIGNMENT TextTypeAlignments.ABOVE_RIGHT_EM_BOX_TEXT_ALIGNMENT TextTypeAlignments.BELOW_LEFT_EM_BOX_TEXT_ALIGNMENT TextTypeAlignments.ABOVE_RIGHT_ICF_BOX_TEXT_ALIGNMENT TextTypeAlignments.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 story.
textStyleRanges	TextStyleRanges	readonly	A collection of text style ranges.
texts	Texts	readonly	A collection of text objects.
words	Words	readonly	A collection of words.

Class

Property	Type	Access	Description
AFTER_PLACE	string	readonly	Dispatched after a TextPath is placed. This event bubbles. This event is not cancelable. (default: afterPlace)
BEFORE_PLACE	string	readonly	Dispatched before a TextPath is placed. This event bubbles. This event is cancelable. (default: beforePlace)

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

Array of Text changeGlyph ([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 Text changeGrep ([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 Text changeText ([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 Text changeTransliterate ([reverseOrder: bool])
Finds text that matches the find character type value and replaces the text with the change character type 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 Text findGlyph ([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 Text findGrep ([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 Text findText ([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 Text findTransliterate ([reverseOrder: bool])
Finds text that matches the find character type value.

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

Array of TextPath getElements ()
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.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)