TextPath

A text object that is on a path.

Go to Property Listing | Method Listing

Methods:

extractLabel, insertLabel, remove, search

Property Listing

Property	Type	Access	Description
centerBracket	Number	readonly	The halfway point between the start bracket and the end bracket.
characters	Characters Character	readonly	A collection of characters.
contents	String TextFrameContents TextFrameContents.PLACEHOLDER_TEXT SpecialCharacters SpecialCharacters.AUTO_PAGE_NUMBER SpecialCharacters.BULLET_CHARACTER SpecialCharacters.COLUMN_BREAK SpecialCharacters.COPYRIGHT_SYMBOL SpecialCharacters.DEGREE_SYMBOL SpecialCharacters.DISCRETIONARY_HYPHEN SpecialCharacters.DOUBLE_LEFT_QUOTE SpecialCharacters.DOUBLE_RIGHT_QUOTE SpecialCharacters.ELLIPSIS_CHARACTER SpecialCharacters.EM_DASH SpecialCharacters.EM_SPACE SpecialCharacters.END_NESTED_STYLE SpecialCharacters.EN_DASH SpecialCharacters.EN_SPACE SpecialCharacters.EVEN_PAGE_BREAK SpecialCharacters.FIGURE_SPACE SpecialCharacters.FLUSH_SPACE SpecialCharacters.FORCED_LINE_BREAK SpecialCharacters.FRAME_BREAK SpecialCharacters.HAIR_SPACE SpecialCharacters.INDENT_HERE_TAB SpecialCharacters.NEXT_PAGE_NUMBER SpecialCharacters.NONBREAKING_HYPHEN SpecialCharacters.NONBREAKING_SPACE SpecialCharacters.ODD_PAGE_BREAK SpecialCharacters.PAGE_BREAK SpecialCharacters.PARAGRAPH_SYMBOL SpecialCharacters.PREVIOUS_PAGE_NUMBER SpecialCharacters.PUNCTUATION_SPACE SpecialCharacters.REGISTERED_TRADEMARK SpecialCharacters.RIGHT_INDENT_TAB SpecialCharacters.SECTION_MARKER SpecialCharacters.SECTION_SYMBOL SpecialCharacters.SINGLE_LEFT_QUOTE SpecialCharacters.SINGLE_RIGHT_QUOTE SpecialCharacters.THIN_SPACE SpecialCharacters.TRADEMARK_SYMBOL	read/write	The contents of the text frame. Can return: String, TextFrameContents enumerator or SpecialCharacters enumerator.
endBracket	Number	read/write	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.
flipPathEffect	FlipValues FlipValues.FLIPPED FlipValues.NOT_FLIPPED FlipValues.UNDEFINED_FLIP_VALUE	read/write	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 InsertionPoint	readonly	A collection of insertion points.
label	String	read/write	A property that can be set to any string.
lines	Lines Line	readonly	A collection of lines.
nextTextFrame	TextFrame TextPath	read/write	The next text frame in the thread. Can return: TextFrame or TextPath.
overflows	Boolean	readonly	If true, the story has overset text.
paragraphs	Paragraphs Paragraph	readonly	A collection of paragraphs.
parent	GraphicLine Oval Rectangle TextFrame PageItem Polygon	readonly	The parent of the TextPath (a PageItem, Oval, Rectangle, GraphicLine, TextFrame or Polygon).
parentStory	Story	readonly	The story that contains the text.
pathAlignment	PathTypeAlignments PathTypeAlignments.BOTTOM_PATH_ALIGNMENT PathTypeAlignments.CENTER_PATH_ALIGNMENT PathTypeAlignments.TOP_PATH_ALIGNMENT	read/write	The alignment of the type on a path.
pathEffect	TextPathEffects TextPathEffects.GRAVITY_PATH_EFFECT TextPathEffects.RAINBOW_PATH_EFFECT TextPathEffects.RIBBON_PATH_EFFECT TextPathEffects.SKEW_PATH_EFFECT TextPathEffects.STAIR_STEP_PATH_EFFECT	read/write	The effect applied to the type on a path.
pathSpacing	Number	read/write	The spacing applied to the type on a path.
previousTextFrame	TextFrame TextPath	read/write	The previous text frame in the thread. Can return: TextFrame or TextPath.
properties	Object	read/write	A property that allows setting of several properties at the same time.
startBracket	Number	read/write	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.ABOVE_RIGHT_EM_BOX_TEXT_ALIGNMENT TextTypeAlignments.ABOVE_RIGHT_ICF_BOX_TEXT_ALIGNMENT TextTypeAlignments.ASCENDER_TEXT_ALIGNMENT TextTypeAlignments.BASELINE_TEXT_ALIGNMENT TextTypeAlignments.BELOW_LEFT_EM_BOX_TEXT_ALIGNMENT TextTypeAlignments.BELOW_LEFT_ICF_BOX_TEXT_ALIGNMENT TextTypeAlignments.CENTER_TEXT_ALIGNMENT TextTypeAlignments.DESCENDER_TEXT_ALIGNMENT	read/write	The alignment applied to the type on a path.
textColumns	TextColumns TextColumn	readonly	A collection of text columns.
textFrameIndex	Number	readonly	The index of the text frame within the story.
textStyleRanges	TextStyleRanges TextStyleRange	readonly	A collection of text style ranges.
texts	Texts Text	readonly	A collection of text objects.
words	Words Word	readonly	A collection of words.

Method Listing

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

undefined 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.

undefined remove ()

Deletes the TextPath.

Text search (for:String, wholeWord:Boolean, caseSensitive:Boolean, replacingWith:String, withFindAttributes:Object, withChangeAttributes:Object)

Look for occurrences of text that matches specific criteria

Parameter	Type	Description
for	String	What to look for (Optional)
wholeWord	Boolean	If true, then disregard text embedded within a larger word (Optional)
caseSensitive	Boolean	If true, then search only for text that matches case (Optional)
replacingWith	String	What to replace the found text with, either a string or a special character (Optional)
withFindAttributes	Object	A record of find preference settings to use (Optional)
withChangeAttributes	Object	A record of change preference settings to use (Optional)