Adobe InDesign CS2 (4.0) Object Model JS: TextPath

InDesign CS2

Class

TextPath

 A text object that is on a path.

QuickLinks

extractLabel, getElements, insertLabel, remove, search, toSource, toSpecifier

Hierarchy

GraphicLine | Oval | PageItem | Polygon | Rectangle | TextFrame
TextPath
Character | InsertionPoint | Line | Paragraph | Text | TextColumn | TextStyleRange | Word

Properties

PropertyTypeAccessDescription
centerBracketnumber readonlyThe halfway point between the start bracket and the end bracket.
charactersCharacters readonlyA collection of characters.
contentsSpecialCharactersString
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.
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.
labelstring r/wA property that can be set to any string.
linesLines readonlyA collection of lines.
nextTextFrameTextFrame
TextPath
r/wThe next text frame in the thread. Can return: TextFrame or TextPath.
overflowsbool readonlyIf true, the story has overset text.
paragraphsParagraphs readonlyA collection of paragraphs.
parentGraphicLine
Oval
PageItem
Polygon
Rectangle
TextFrame
readonlyThe parent of the TextPath (a PageItem, Oval, Rectangle, GraphicLine, TextFrame or Polygon).
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.
previousTextFrameTextFrame
TextPath
r/wThe previous text frame in the thread. Can return: TextFrame or TextPath.
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.

Methods

Instances

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

ParameterTypeDescription
keystringThe key.

Array of Object 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.

Array of Text search ([for: string][, wholeWord: bool][, caseSensitive: bool][, replacingWith: string][, withFindAttributes: Object][, withChangeAttributes: Object])
Look for occurrences of text that matches specific criteria

ParameterTypeDescription
forstringWhat to look for (Optional)
wholeWordboolIf true, then disregard text embedded within a larger word (Optional)
caseSensitiveboolIf true, then search only for text that matches case (Optional)
replacingWithstringWhat to replace the found text with, either a string or a special character (Optional)
withFindAttributesObjectA record of find preference settings to use (Optional)
withChangeAttributesObjectA record of change preference settings to use (Optional)

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:

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

TextPath TextPaths.nextItem (obj: TextPath)

TextPath TextPaths.previousItem (obj: TextPath)

Return

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)

Jongware, 27-Jun-2010 v3.0.3dContents :: Index