Adobe Illustrator CS6 Type Library JS: TextFrameItem

Illustrator CS6

Class

TextFrameItem

 Text frame item. Base Class: PageItem

QuickLinks

createOutline, duplicate, move, remove, removeAll

Hierarchy

Object
PageItem
TextFrameItem

Properties

PropertyTypeAccessDescription
anchorPoint r/wThe position of the anchor point (start of base line for point text)
antialiasTextAntialias:
TextAntialias.NONE
TextAntialias.SHARP
TextAntialias.CRISP
TextAntialias.STRONG
r/wThe type of a text anti-aliasing on text frame item.
charactersCharacters readonlyAll the characters in this text range.
columnCountInt32 r/wThe column count in the text frame (area text only)
columnGutternumber r/wThe column gutter in the text frame (area text only)
contentVariableany r/wThe content variable bound to this text art item.
contentsstring r/wThe text contents of this text frame.
endTValuenumber r/wThe end position of text along a path, as a value relative to the path's segments (path text only)
firstBaselineFirstBaselineType:
FirstBaselineType.BASELINEASCENT
FirstBaselineType.BASELINECAPHEIGHT
FirstBaselineType.BASELINELEADING
FirstBaselineType.BASELINEXHEIGHT
FirstBaselineType.BASELINEEMBOXHEIGHT
FirstBaselineType.BASELINEFIXED
FirstBaselineType.BASELINELEGACY
r/wThe first baseline offset type for text frame item (for Area Text only)
firstBaselineMinnumber r/wThe first baseline offset minimum value for text frame item (for Area Text only)
flowLinksHorizontallybool r/wFlow text between linked frame horizontally first. (area text only)
insertionPointsInsertionPoints InsertionPoint readonlyAll the insertion points in this text range.
kindTextType:
TextType.POINTTEXT
TextType.AREATEXT
TextType.PATHTEXT
readonlyThe type of a text frame item.
linesLines readonlyAll the lines in this text range.
matrixMatrix readonlyThe transformation matrix of the text frame object.
nextFrameTextFrameItem r/wThe linked text frame following this one.
opticalAlignmentbool r/wIs the optical alignment active?
orientationTextOrientation:
TextOrientation.HORIZONTAL
TextOrientation.VERTICAL
r/wThe orientation of the text in the frame.
paragraphsParagraphs readonlyAll the paragraphs in this text range.
parentObject readonlyThe object's container.
previousFrameTextFrameItem r/wThe linked text frame preceding this one.
rowCountInt32 r/wThe row count in the text frame (area text only)
rowGutternumber r/wThe row gutter in the text frame (area text only)
spacingnumber r/wThe amount of spacing (path text only)
startTValuenumber r/wThe start position of text along a path, as a value relative to the path's segments (path text only)
storyStory readonlyThe story of the text frame.
textPathTextPath readonlyThe path for the text frame (area and path text)
textRangeTextRange readonlyThe text range of the text frame.
textRangesTextRanges TextRange readonlyAll the text in this text range.
textSelectionArray of TextRange readonlyThe selected text (ranges) in the story.
typenamestring readonlyThe class name of the object.
wordsWords readonlyAll the words in this text range.

Methods

Instances

GroupItem createOutline ()
Convert text item to path items.

TextFrameItem duplicate (relativeObject: Object, insertionLocation: ElementPlacement)
Duplicate this object.

ParameterTypeDescription
relativeObjectObject
insertionLocationElementPlacement

TextFrameItem move (relativeObject: Object, insertionLocation: ElementPlacement)
Move the object.

ParameterTypeDescription
relativeObjectObject
insertionLocationElementPlacement

void remove ()
Deletes this object.

void removeAll ()
Deletes all elements.

Element of

TextFrameItem.nextFrame

TextFrameItem.previousFrame

Used in:

TextFrameItem TextFrameItems.areaText (textPath: PathItem[, orientation: TextOrientation=TextOrientation.HORIZONTAL][, baseFrame: TextFrameItem][, postFix: bool=true])

TextFrameItem TextFrameItems.pathText (textPath: PathItem[, startTValue: number=0.0][, endTValue: number=0.0][, orientation: TextOrientation=TextOrientation.HORIZONTAL][, baseFrame: TextFrameItem][, postFix: bool=true])

Return

TextFrameItem TextFrameItem.duplicate (relativeObject: Object, insertionLocation: ElementPlacement)

TextFrameItem TextFrameItem.move (relativeObject: Object, insertionLocation: ElementPlacement)

TextFrameItem TextFrameItems.add ()

TextFrameItem TextFrameItems.areaText (textPath: PathItem[, orientation: TextOrientation=TextOrientation.HORIZONTAL][, baseFrame: TextFrameItem][, postFix: bool=true])

TextFrameItem TextFrameItems.getByName (name: string)

TextFrameItem TextFrameItems.pathText (textPath: PathItem[, startTValue: number=0.0][, endTValue: number=0.0][, orientation: TextOrientation=TextOrientation.HORIZONTAL][, baseFrame: TextFrameItem][, postFix: bool=true])

TextFrameItem TextFrameItems.pointText (anchor: Point[, orientation: TextOrientation=TextOrientation.HORIZONTAL])

Jongware, 25-Nov-2012 v3.0.3iContents :: Index