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

EPSText | GraphicLine | Oval | Polygon | Rectangle | SplineItem | TextFrame
TextPath
Character | Event | EventListener | InsertionPoint | Line | MutationEvent | Paragraph | Text | TextColumn | TextStyleRange | Word

Properties

PropertyTypeAccessDescription
centerBracketnumber readonlyThe halfway point between the start bracket and the end bracket.
charactersCharacters readonlyA collection of characters.
contentsSpecialCharacters
String
TextFrameContents
r/wThe contents of the text frame. Can return: String, TextFrameContents enumerator or SpecialCharacters enumerator.
endBracketnumber r/wThe end of the type on a path. Note: Additional text becomes overset text unless the text is linked to another path or text frame.
endTextFrameTextFrame
TextPath
readonlyThe last text frame in the thread. Can return: TextFrame or TextPath.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
flipPathEffectFlipValues:
FlipValues.NOT_FLIPPED
FlipValues.FLIPPED
FlipValues.UNDEFINED_FLIP_VALUE
r/wThe flip effect applied to the type on a path.
idnumber readonlyThe unique ID of the TextPath.
indexnumber readonlyThe index of the TextPath within its containing object.
insertionPointsInsertionPoints readonlyA collection of insertion points.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
linesLines readonlyA collection of lines.
namestring r/wThe name of the TextPath; this is an alias to the TextPath's label property.
nextTextFrameNothingEnum
TextFrame
TextPath
r/wThe next text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator.
overflowsbool readonlyIf true, the story has overset text.
paragraphsParagraphs readonlyA collection of paragraphs.
parentEPSText
GraphicLine
Oval
Polygon
Rectangle
SplineItem
TextFrame
readonlyThe parent of the TextPath (a SplineItem, Polygon, GraphicLine, Rectangle, Oval, TextFrame or EPSText).
parentStoryStory readonlyThe story that contains the text.
pathAlignmentPathTypeAlignments:
PathTypeAlignments.TOP_PATH_ALIGNMENT
PathTypeAlignments.BOTTOM_PATH_ALIGNMENT
PathTypeAlignments.CENTER_PATH_ALIGNMENT
r/wThe alignment of the type on a path.
pathEffectTextPathEffects:
TextPathEffects.RAINBOW_PATH_EFFECT
TextPathEffects.SKEW_PATH_EFFECT
TextPathEffects.RIBBON_PATH_EFFECT
TextPathEffects.STAIR_STEP_PATH_EFFECT
TextPathEffects.GRAVITY_PATH_EFFECT
r/wThe effect applied to the type on a path.
pathSpacingnumber r/wThe spacing applied to the type on a path.
previousTextFrameNothingEnum
TextFrame
TextPath
r/wThe previous text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator.
propertiesObject r/wA property that allows setting of several properties at the same time.
startBracketnumber r/wThe location of the start of the type on the path, expressed in points. Note: 0 is the first point on the path.
startTextFrameTextFrame
TextPath
readonlyThe first text frame in the thread. Can return: TextFrame or TextPath.
textAlignmentTextTypeAlignments:
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/wThe alignment applied to the type on a path.
textColumnsTextColumns readonlyA collection of text columns.
textFrameIndexnumber readonlyThe index of the text frame within the story.
textStyleRangesTextStyleRanges readonlyA collection of text style ranges.
textsTexts readonlyA collection of text objects.
wordsWords readonlyA collection of words.

Class

PropertyTypeAccessDescription
AFTER_PLACEstring readonlyDispatched after a TextPath is placed. This event bubbles. This event is not cancelable. (default: afterPlace)
BEFORE_PLACEstring readonlyDispatched 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.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis 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.

ParameterTypeDescription
reverseOrderboolIf 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.

ParameterTypeDescription
reverseOrderboolIf 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.

ParameterTypeDescription
reverseOrderboolIf 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.

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

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

ParameterTypeDescription
keystringThe key.

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

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

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

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

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

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

Array of Text findTransliterate ([reverseOrder: bool])
Finds text that matches the find character type value.

ParameterTypeDescription
reverseOrderboolIf 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.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

void remove ()
Deletes the TextPath.

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

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

TextFrame.endTextFrame

TextFrame.nextTextFrame

TextFrame.previousTextFrame

TextFrame.startTextFrame

TextPath.endTextFrame

TextPath.nextTextFrame

TextPath.previousTextFrame

TextPath.startTextFrame

Used in:

TextPath TextPaths.nextItem (obj: TextPath)

TextPath TextPaths.previousItem (obj: TextPath)

Return

Array of TextPath TextPath.getElements ()

TextPath TextPaths.[] (index: number)

TextPath TextPaths.add ([withProperties: Object])

TextPath TextPaths.anyItem ()

Array of TextPath TextPaths.everyItem ()

TextPath TextPaths.firstItem ()

TextPath TextPaths.item (index: varies)

TextPath TextPaths.itemByID (id: number)

TextPath TextPaths.itemByName (name: string)

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

TextPath TextPaths.lastItem ()

TextPath TextPaths.middleItem ()

TextPath TextPaths.nextItem (obj: TextPath)

TextPath TextPaths.previousItem (obj: TextPath)

Jongware, 28-Apr-2012 v3.0.3hContents :: Index