TextFrameItem

Text frame item.

Go to Property Listing | Method Listing

Methods:

convertAreaObjectToPointObject, convertPointObjectToAreaObject, createOutline, duplicate, generateThumbnailWithTextFrameProperties, move, remove, removeAll

Objects:

Boolean, Characters, FirstBaselineType, InsertionPoints, Lines, Matrix, Number, Paragraphs, Point, Story, String, TextAntialias, TextFrameItem, TextOrientation, TextPath, TextRange, TextRanges, TextType, Words

Hierarchy:

Superclass: PageItem

Class: TextFrameItem

Property Listing

Property	Type	Access	Description
anchor	Point	read/write	The position of the anchor point (start of base line for point text)
antialias	TextAntialias TextAntialias.CRISP TextAntialias.NONE TextAntialias.SHARP TextAntialias.STRONG	read/write	The type of a text anti-aliasing on text frame item.
characters	Characters	readonly	All the characters in this text range.
columnCount	Int32	read/write	The column count in the text frame (area text only)
columnGutter	Number	read/write	The column gutter in the text frame (area text only)
contentVariable	Varies	read/write	The content variable bound to this text art item.
contents	String	read/write	The text contents of this text frame.
endTValue	Number	read/write	The end position of text along a path, as a value relative to the path's segments (path text only)
firstBaseline	FirstBaselineType FirstBaselineType.BASELINEASCENT FirstBaselineType.BASELINECAPHEIGHT FirstBaselineType.BASELINEEMBOXHEIGHT FirstBaselineType.BASELINEFIXED FirstBaselineType.BASELINELEADING FirstBaselineType.BASELINELEGACY FirstBaselineType.BASELINEXHEIGHT	read/write	The first baseline offset type for text frame item (for Area Text only)
firstBaselineMin	Number	read/write	The first baseline offset minimum value for text frame item (for Area Text only)
flowLinksHorizontally	Boolean	read/write	Flow text between linked frame horizontally first. (area text only)
insertionPoints	InsertionPoints InsertionPoint	readonly	All the insertion points in this text range.
kind	TextType TextType.AREATEXT TextType.PATHTEXT TextType.POINTTEXT	readonly	The type of a text frame item.
lines	Lines	readonly	All the lines in this text range.
matrix	Matrix	readonly	The transformation matrix of the text frame object.
nextFrame	TextFrameItem	read/write	The linked text frame following this one.
opticalAlignment	Boolean	read/write	Is the optical alignment active?
orientation	TextOrientation TextOrientation.HORIZONTAL TextOrientation.VERTICAL	read/write	The orientation of the text in the frame.
paragraphs	Paragraphs	readonly	All the paragraphs in this text range.
parent		readonly	The object's container.
previousFrame	TextFrameItem	read/write	The linked text frame preceding this one.
rowCount	Int32	read/write	The row count in the text frame (area text only)
rowGutter	Number	read/write	The row gutter in the text frame (area text only)
spacing	Number	read/write	The amount of spacing (path text only)
startTValue	Number	read/write	The start position of text along a path, as a value relative to the path's segments (path text only)
story	Story	readonly	The story of the text frame.
textPath	TextPath	readonly	The path for the text frame (area and path text)
textRange	TextRange	readonly	The text range of the text frame.
textRanges	TextRanges TextRange	readonly	All the text in this text range.
textSelection	Array of TextRange	readonly	The selected text (ranges) in the story.
typename	String	readonly	The class name of the object.
words	Words	readonly	All the words in this text range.

Method Listing

TextFrameItem convertAreaObjectToPointObject ()

Convert Area Type Text Object To Point Type Object.

TextFrameItem convertPointObjectToAreaObject ()

Convert Point Type Text Object To Area Type Object.

GroupItem createOutline ()

Convert text item to path items.

TextFrameItem duplicate (relativeObject:Object, insertionLocation:ElementPlacement)

Duplicate this object.

Parameter	Type	Description
relativeObject	Object
insertionLocation	ElementPlacement

undefined generateThumbnailWithTextFrameProperties (textString:String, fontSize:Number, textColor:Color, destinationPath:File)

Generates the thumbnail with the properties of first character in the text frame.

Parameter	Type	Description
textString	String	The text string which is to be used in the thumbnail generation.
fontSize	Number	The size in points of the text string.
textColor	Color	The color of the text string.
destinationPath	File	The location at which the thumbnail is to be stored.