TextPath

A text object that is on a path.

Methods:

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

Objects:

Boolean, Characters, EventListeners, Events, FlipValues, InsertionPoints, Lines, Number, Object, Paragraphs, PathTypeAlignments, SpecialCharacters, Story, String, TextColumns, TextFrame, TextFrameContents, TextPath, TextPathEffects, TextStyleRanges, TextTypeAlignments, Texts, Words

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

TextFrameContents.PLACEHOLDER_TEXT_ARABIC

TextFrameContents.PLACEHOLDER_TEXT_CYRILLIC

TextFrameContents.PLACEHOLDER_TEXT_GREEK

TextFrameContents.PLACEHOLDER_TEXT_HEBREW

SpecialCharacters

SpecialCharacters.ARABIC_COMMA

SpecialCharacters.ARABIC_KASHIDA

SpecialCharacters.ARABIC_QUESTION_MARK

SpecialCharacters.ARABIC_SEMICOLON

SpecialCharacters.AUTO_PAGE_NUMBER

SpecialCharacters.BULLET_CHARACTER

SpecialCharacters.COLUMN_BREAK

SpecialCharacters.COPYRIGHT_SYMBOL

SpecialCharacters.DEGREE_SYMBOL

SpecialCharacters.DISCRETIONARY_HYPHEN

SpecialCharacters.DISCRETIONARY_LINE_BREAK

SpecialCharacters.DOTTED_CIRCLE

SpecialCharacters.DOUBLE_LEFT_QUOTE

SpecialCharacters.DOUBLE_RIGHT_QUOTE

SpecialCharacters.DOUBLE_STRAIGHT_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.FIXED_WIDTH_NONBREAKING_SPACE

SpecialCharacters.FLUSH_SPACE

SpecialCharacters.FOOTNOTE_SYMBOL

SpecialCharacters.FORCED_LINE_BREAK

SpecialCharacters.FRAME_BREAK

SpecialCharacters.HAIR_SPACE

SpecialCharacters.HEBREW_GERESH

SpecialCharacters.HEBREW_GERSHAYIM

SpecialCharacters.HEBREW_MAQAF

SpecialCharacters.HEBREW_SOF_PASUK

SpecialCharacters.INDENT_HERE_TAB

SpecialCharacters.LEFT_TO_RIGHT_EMBEDDING

SpecialCharacters.LEFT_TO_RIGHT_MARK

SpecialCharacters.LEFT_TO_RIGHT_OVERRIDE

SpecialCharacters.NEXT_PAGE_NUMBER

SpecialCharacters.NONBREAKING_HYPHEN

SpecialCharacters.NONBREAKING_SPACE

SpecialCharacters.ODD_PAGE_BREAK

SpecialCharacters.PAGE_BREAK

SpecialCharacters.PARAGRAPH_SYMBOL

SpecialCharacters.POP_DIRECTIONAL_FORMATTING

SpecialCharacters.PREVIOUS_PAGE_NUMBER

SpecialCharacters.PUNCTUATION_SPACE

SpecialCharacters.QUARTER_SPACE

SpecialCharacters.REGISTERED_TRADEMARK

SpecialCharacters.RIGHT_INDENT_TAB

SpecialCharacters.RIGHT_TO_LEFT_EMBEDDING

SpecialCharacters.RIGHT_TO_LEFT_MARK

SpecialCharacters.RIGHT_TO_LEFT_OVERRIDE

SpecialCharacters.SECTION_MARKER

SpecialCharacters.SECTION_SYMBOL

SpecialCharacters.SINGLE_LEFT_QUOTE

SpecialCharacters.SINGLE_RIGHT_QUOTE

SpecialCharacters.SINGLE_STRAIGHT_QUOTE

SpecialCharacters.SIXTH_SPACE

SpecialCharacters.TEXT_VARIABLE

SpecialCharacters.THIN_SPACE

SpecialCharacters.THIRD_SPACE

SpecialCharacters.TRADEMARK_SYMBOL

SpecialCharacters.ZERO_WIDTH_JOINER

SpecialCharacters.ZERO_WIDTH_NONJOINER

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.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

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.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

label

String

read/write

A property that can be set to any string.

lines

Lines Line

readonly

A collection of lines.

name

String

read/write

The name of the TextPath; this is an alias to the TextPath's label property.

nextTextFrame

TextFrame

TextPathCanalsoaccept:NothingEnum

read/write

The next text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator.

overflows

Boolean

readonly

If true, the story has overset text.

paragraphs

Paragraphs Paragraph

readonly

A collection of paragraphs.

parent

EndnoteTextFrame

GraphicLine

Oval

Polygon

Rectangle

TextFrame

EPSText

SplineItem

readonly

The parent of the TextPath (a SplineItem, Polygon, GraphicLine, Rectangle, Oval, TextFrame, EndnoteTextFrame or EPSText).

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

TextPathCanalsoaccept:NothingEnum

read/write

The previous text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator.

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.

Constants/Events

Name

Type

Access

Description

AFTER_PLACE

String

readonly

Dispatched after a TextPath is placed. This event bubbles. This event is not cancelable.

BEFORE_PLACE

String

readonly

Dispatched before a TextPath is placed. This event bubbles. This event is cancelable.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

Text changeGlyph (reverseOrder:Boolean)

Finds glyphs that match the find what value and replaces the glyphs with the change to value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

Text changeGrep (reverseOrder:Boolean)

Finds text that matches the find what value and replaces the text with the change to value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

Text changeText (reverseOrder:Boolean)

Finds text that matches the find what value and replaces the text with the change to value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

Text changeTransliterate (reverseOrder:Boolean)

Finds text that matches the find character type value and replaces the text with the change character type value.

Parameter

Type

Description

reverseOrder

Boolean

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.

Text findGlyph (reverseOrder:Boolean)

Finds glyphs that match the find what value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

Text findGrep (reverseOrder:Boolean)

Finds text that matches the find what value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

Text findText (reverseOrder:Boolean)

Finds text that matches the find what value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

Text findTransliterate (reverseOrder:Boolean)

Finds text that matches the find character type value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

TextPath getElements ()

Resolves the object specifier, creating an array of object references.

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.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

TextFrame.startTextFrame

EndnoteTextFrame.startTextFrame

TextPath.startTextFrame

TextFrame.endTextFrame

EndnoteTextFrame.endTextFrame

TextPath.endTextFrame

Character.parent

Event.parent

EventListener.parent

InsertionPoint.parent

Line.parent

MutationEvent.parent

Paragraph.parent

Text.parent

TextColumn.parent

TextStyleRange.parent

Word.parent

Return

TextPaths.add()

TextPath.getElements()

TextPaths.anyItem()

TextPaths.everyItem()

TextPaths.nextItem()

TextPaths.previousItem()

TextPaths.itemByID()

TextPaths.item()

TextPaths.[]()

TextPaths.itemByName()

TextPaths.itemByRange()

TextPaths.firstItem()

TextPaths.lastItem()

TextPaths.middleItem()