Packagecom.adobe.illustrator
Classpublic class TextFrame
InheritanceTextFrame Inheritance PageItem Inheritance IllustratorHostObject Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5

Text frame item.



Public Properties
 PropertyDefined By
  anchor : Array
The position of the anchor point (start of base line for point text)
TextFrame
  antialias : TextAntialias
the type of a text anti-aliasing on text frame item
TextFrame
 InheritedartworkKnockout : KnockoutState
Is the artwork used to create a knockout.
PageItem
 InheritedblendingMode : BlendModes
The mode used when compositing an object.
PageItem
  characters : Characters
[read-only] All the characters in this text range.
TextFrame
  columnCount : Number
The column count in the text frame (area text only)
TextFrame
  columnGutter : Number
The column gutter in the text frame (area text only)
TextFrame
  contents : String
The text contents of this text frame.
TextFrame
  contentVariable : Object
The content variable bound to this text art item.
TextFrame
 InheritedcontrolBounds : Array
[read-only] The bounds of the artwork including stroke width and controls.
PageItem
 Inheritededitable : Boolean
[read-only] Can the art item be modified.
PageItem
  endTValue : Number
The end position of text along a path, as a value relative to the path's segments (path text only)
TextFrame
  flowLinksHorizontally : Boolean
Flow text between linked frame horizontally first.
TextFrame
 InheritedgeometricBounds : Array
[read-only] The bounds of the artwork excluding stroke width.
PageItem
 Inheritedheight : Number
The height of the art item.
PageItem
 Inheritedhidden : Boolean
Is this artwork item hidden?
PageItem
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  insertionPoints : InsertionPoints
[read-only] All the insertion points in this text range.
TextFrame
 InheritedisIsolated : Boolean
Is the artwork isolated.
PageItem
  kind : TextType
[read-only] The type of a text frame item.
TextFrame
 Inheritedlayer : Layer
[read-only] The layer to which this artwork belongs.
PageItem
 Inheritedleft : Number
The left position of the art item.
PageItem
  lines : Lines
[read-only] All the lines in this text range.
TextFrame
 Inheritedlocked : Boolean
Is this artwork item locked?
PageItem
  matrix : Matrix
[read-only] The transformation matrix of the text frame object.
TextFrame
 Inheritedname : String
The item's name.
PageItem
  nextFrame : TextFrame
The linked text frame following this one.
TextFrame
 Inheritednote : String
The note assigned to this artwork item.
PageItem
 Inheritedopacity : Number
The object's opacity (between 0.0 and 100.0) ( 0.0 - 100.0 )
PageItem
  opticalAlignment : Boolean
Is the optical alignment active?
TextFrame
  orientation : TextOrientation
The orientation of the text in the frame.
TextFrame
  paragraphs : Paragraphs
[read-only] All the paragraphs in this text range.
TextFrame
 Inheritedparent : *
[read-only]
IllustratorHostObject
 InheritedpixelAligned : Boolean
is this artwork item aligned to Pixel Grid?
PageItem
 Inheritedposition : Array
The position of the top left corner of the art item.
PageItem
  previousFrame : TextFrame
The linked text frame preceding this one.
TextFrame
  rowCount : Number
The row count in the text frame (area text only)
TextFrame
  rowGutter : Number
The row gutter in the text frame (area text only)
TextFrame
 Inheritedselected : Boolean
Is this artwork item selected?
PageItem
 Inheritedsliced : Boolean
Is the art item sliced (default: false)
PageItem
  spacing : Number
The amount of spacing (path text only)
TextFrame
  startTValue : Number
The start position of text along a path, as a value relative to the path's segments (path text only)
TextFrame
  story : Story
[read-only] The story of the text frame.
TextFrame
 Inheritedtags : Tags
[read-only] The collection of tags associated with this page item.
PageItem
  textPath : TextPath
[read-only] The path for the text frame (area and path text)
TextFrame
  textRange : TextRange
[read-only] The text range of the text frame.
TextFrame
  textRanges : TextRanges
[read-only] All the text in this text range.
TextFrame
  textSelection : Object
[read-only] The selected text (ranges) in the story.
TextFrame
 Inheritedtop : Number
The top position of the art item.
PageItem
 InheriteduRL : String
The value of the Adobe URL tag assigned to this artwork item.
PageItem
 InheritedvisibilityVariable : Object
The visibility variable bound to this page item.
PageItem
 InheritedvisibleBounds : Array
[read-only] The visible bounds of the artwork including stroke width.
PageItem
 Inheritedwidth : Number
The width of the art item.
PageItem
  words : Words
[read-only] All the words in this text range.
TextFrame
 InheritedwrapInside : Boolean
Should the text frame object be wrapped inside this object?
PageItem
 InheritedwrapOffset : Number
Use this offset when wrapping text around this object.
PageItem
 Inheritedwrapped : Boolean
Wrap text frame objects around this object (text frame must be above the object)
PageItem
 InheritedzOrderPosition : Number
[read-only] The drawing order of the art within it's group or layer.
PageItem
Public Methods
 MethodDefined By
 Inherited
bringInPerspective(positionX:Number, positionY:Number, perspectiveGridPlane:PerspectiveGridPlaneType = null):void
Place art object(s)in perspective grid at spedified perspective plane and coordinate
PageItem
  
Convert text item to path items.
TextFrame
 Inherited
duplicate(relativeObject:Object = null, insertionLocation:ElementPlacement = null):PageItem
create a duplicate of the object
PageItem
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
 Inherited
move(relativeObject:Object, insertionLocation:ElementPlacement):void
move the object
PageItem
 Inherited
remove():void
delete the object
PageItem
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
 Inherited
resize(scaleX:Number, scaleY:Number, changePositions:Boolean = true, changeFillPatterns:Boolean = true, changeFillGradients:Boolean = true, changeStrokePattern:Boolean = true, changeLineWidths:Number = 100.0, scaleAbout:Transformation = null):void
Scale art object(s)
PageItem
 Inherited
rotate(angle:Number, changePositions:Boolean = true, changeFillPatterns:Boolean = true, changeFillGradients:Boolean = true, changeStrokePattern:Boolean = true, rotateAbout:Transformation = null):void
Rotate art object(s)
PageItem
 Inherited
transform(transformationMatrix:Matrix, changePositions:Boolean = true, changeFillPatterns:Boolean = true, changeFillGradients:Boolean = true, changeStrokePattern:Boolean = true, changeLineWidths:Number = 100.0, transformAbout:Transformation = null):void
Transform art object(s) using a transformation matrix.
PageItem
 Inherited
translate(deltaX:Number = 0.0, deltaY:Number = 0.0, transformObjects:Boolean = true, transformFillPatterns:Boolean = true, transformFillGradients:Boolean = true, transformStrokePattern:Boolean = true):void
Reposition art object(s)
PageItem
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
 Inherited
zOrder(zOrderCmd:ZOrderMethod):void
Arranges the art relative to other art in the group or layer.
PageItem
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
anchorproperty
anchor:Array

Since : CS5

The position of the anchor point (start of base line for point text)


Implementation
    public function get anchor():Array
    public function set anchor(value:Array):void
antialiasproperty 
antialias:TextAntialias

Since : CS5.5

the type of a text anti-aliasing on text frame item


Implementation
    public function get antialias():TextAntialias
    public function set antialias(value:TextAntialias):void
charactersproperty 
characters:Characters  [read-only]

Since : CS5

All the characters in this text range.


Implementation
    public function get characters():Characters
columnCountproperty 
columnCount:Number

Since : CS5

The column count in the text frame (area text only)


Implementation
    public function get columnCount():Number
    public function set columnCount(value:Number):void
columnGutterproperty 
columnGutter:Number

Since : CS5

The column gutter in the text frame (area text only)


Implementation
    public function get columnGutter():Number
    public function set columnGutter(value:Number):void
contentsproperty 
contents:String

Since : CS5

The text contents of this text frame.


Implementation
    public function get contents():String
    public function set contents(value:String):void
contentVariableproperty 
contentVariable:Object

Since : CS5

The content variable bound to this text art item.


Implementation
    public function get contentVariable():Object
    public function set contentVariable(value:Object):void
endTValueproperty 
endTValue:Number

Since : CS5

The end position of text along a path, as a value relative to the path's segments (path text only)


Implementation
    public function get endTValue():Number
    public function set endTValue(value:Number):void
flowLinksHorizontallyproperty 
flowLinksHorizontally:Boolean

Since : CS5

Flow text between linked frame horizontally first. (area text only)


Implementation
    public function get flowLinksHorizontally():Boolean
    public function set flowLinksHorizontally(value:Boolean):void
insertionPointsproperty 
insertionPoints:InsertionPoints  [read-only]

Since : CS5

All the insertion points in this text range.


Implementation
    public function get insertionPoints():InsertionPoints
kindproperty 
kind:TextType  [read-only]

Since : CS5

The type of a text frame item.


Implementation
    public function get kind():TextType
linesproperty 
lines:Lines  [read-only]

Since : CS5

All the lines in this text range.


Implementation
    public function get lines():Lines
matrixproperty 
matrix:Matrix  [read-only]

Since : CS5

The transformation matrix of the text frame object.


Implementation
    public function get matrix():Matrix
nextFrameproperty 
nextFrame:TextFrame

Since : CS5

The linked text frame following this one.


Implementation
    public function get nextFrame():TextFrame
    public function set nextFrame(value:TextFrame):void
opticalAlignmentproperty 
opticalAlignment:Boolean

Since : CS5

Is the optical alignment active?


Implementation
    public function get opticalAlignment():Boolean
    public function set opticalAlignment(value:Boolean):void
orientationproperty 
orientation:TextOrientation

Since : CS5

The orientation of the text in the frame.


Implementation
    public function get orientation():TextOrientation
    public function set orientation(value:TextOrientation):void
paragraphsproperty 
paragraphs:Paragraphs  [read-only]

Since : CS5

All the paragraphs in this text range.


Implementation
    public function get paragraphs():Paragraphs
previousFrameproperty 
previousFrame:TextFrame

Since : CS5

The linked text frame preceding this one.


Implementation
    public function get previousFrame():TextFrame
    public function set previousFrame(value:TextFrame):void
rowCountproperty 
rowCount:Number

Since : CS5

The row count in the text frame (area text only)


Implementation
    public function get rowCount():Number
    public function set rowCount(value:Number):void
rowGutterproperty 
rowGutter:Number

Since : CS5

The row gutter in the text frame (area text only)


Implementation
    public function get rowGutter():Number
    public function set rowGutter(value:Number):void
spacingproperty 
spacing:Number

Since : CS5

The amount of spacing (path text only)


Implementation
    public function get spacing():Number
    public function set spacing(value:Number):void
startTValueproperty 
startTValue:Number

Since : CS5

The start position of text along a path, as a value relative to the path's segments (path text only)


Implementation
    public function get startTValue():Number
    public function set startTValue(value:Number):void
storyproperty 
story:Story  [read-only]

Since : CS5

The story of the text frame.


Implementation
    public function get story():Story
textPathproperty 
textPath:TextPath  [read-only]

Since : CS5

The path for the text frame (area and path text)


Implementation
    public function get textPath():TextPath
textRangeproperty 
textRange:TextRange  [read-only]

Since : CS5

The text range of the text frame.


Implementation
    public function get textRange():TextRange
textRangesproperty 
textRanges:TextRanges  [read-only]

Since : CS5

All the text in this text range.


Implementation
    public function get textRanges():TextRanges
textSelectionproperty 
textSelection:Object  [read-only]

Since : CS5

The selected text (ranges) in the story.


Implementation
    public function get textSelection():Object
wordsproperty 
words:Words  [read-only]

Since : CS5

All the words in this text range.


Implementation
    public function get words():Words
Method Detail
createOutline()method
public function createOutline():GroupItem

Since : CS5

Convert text item to path items.

Returns
GroupItem