Package | com.adobe.indesign |
Class | public class TextFrame |
Inheritance | TextFrame ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
absoluteFlip : Flip [override]
Indicates whether the TextFrame has been flipped independently of its parent object and, if yes, the direction in which the TextFrame was flipped. | TextFrame | ||
absoluteHorizontalScale : Number [override]
The horizontal scale of the TextFrame relative to its containing object. | TextFrame | ||
absoluteRotationAngle : Number [override]
The rotation angle of the TextFrame relative to its containing object. | TextFrame | ||
absoluteShearAngle : Number [override]
The skewing angle of the TextFrame relative to its containing object. | TextFrame | ||
absoluteVerticalScale : Number [override]
The vertical scale of the TextFrame relative to its containing object. | TextFrame | ||
AFTER_PLACE : String [static] [read-only]
Dispatched after a TextFrame is placed. | TextFrame | ||
allArticles : Object [override] [read-only]
The list of all articles this page item is part of
| TextFrame | ||
allGraphics : Object [override] [read-only]
Lists all graphics contained by the TextFrame. | TextFrame | ||
allowOverrides : Boolean [override]
If true, the master page item can be overridden. | TextFrame | ||
allPageItems : Object [override] [read-only]
Lists all page items contained by the TextFrame. | TextFrame | ||
anchoredObjectSettings : AnchoredObjectSetting [read-only]
Anchored object settings. | TextFrame | ||
animationSettings : AnimationSetting [override] [read-only]
The page item animation settings. | TextFrame | ||
appliedObjectStyle : ObjectStyle [override]
The object style applied to the TextFrame. | TextFrame | ||
associatedXMLElement : XMLItem [override] [read-only]
The XML element associated with the TextFrame. | TextFrame | ||
baselineFrameGridOptions : BaselineFrameGridOption [read-only]
Baseline frame grid option settings. | TextFrame | ||
BEFORE_PLACE : String [static] [read-only]
Dispatched before a TextFrame is placed. | TextFrame | ||
bottomLeftCornerOption : CornerOptions [override]
The shape to apply to the bottom left corner of rectangular shapes. | TextFrame | ||
bottomLeftCornerRadius : Object [override]
The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
| TextFrame | ||
bottomRightCornerOption : CornerOptions [override]
The shape to apply to the bottom right corner of rectangular shapes. | TextFrame | ||
bottomRightCornerRadius : Object [override]
The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
| TextFrame | ||
buttons : Buttons [read-only]
A collection of buttons. | TextFrame | ||
characters : Characters [read-only]
A collection of characters. | TextFrame | ||
contents : Object
The contents of the text frame. | TextFrame | ||
contentTransparencySettings : ContentTransparencySetting [override] [read-only]
Transparency settings for the content of the TextFrame. | TextFrame | ||
contentType : ContentType
The type of content that a frame can contain. | TextFrame | ||
endCap : EndCap [override]
The end shape of an open path. | TextFrame | ||
endJoin : EndJoin [override]
The corner join applied to the TextFrame. | TextFrame | ||
endTextFrame : Object [read-only]
The last text frame in the thread. | TextFrame | ||
epstexts : EPSTexts [read-only]
EPSTexts
| TextFrame | ||
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | TextFrame | ||
events : Events [override] [read-only]
A collection of events. | TextFrame | ||
fillColor : Swatch [override]
The swatch (color, gradient, tint, or mixed ink) applied to the fill of the TextFrame. | TextFrame | ||
fillTint : Number [override]
The percent of tint to use in the TextFrame's fill color. | TextFrame | ||
fillTransparencySettings : FillTransparencySetting [override] [read-only]
Transparency settings for the fill applied to the TextFrame. | TextFrame | ||
flip : Flip [override]
The direction in which to flip the printed image. | TextFrame | ||
footnotes : Footnotes [read-only]
A collection of footnotes. | TextFrame | ||
formFields : FormFields [read-only]
A collection of form fields. | TextFrame | ||
gapColor : Swatch [override]
The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. | TextFrame | ||
gapTint : Number [override]
The tint as a percentage of the gap color. | TextFrame | ||
geometricBounds : Object [override]
The bounds of the TextFrame excluding the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box. | TextFrame | ||
gradientFillAngle : Number [override]
The angle of a linear gradient applied to the fill of the TextFrame. | TextFrame | ||
gradientFillLength : Object [override]
The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the TextFrame. | TextFrame | ||
gradientFillStart : Object [override]
The starting point (in page coordinates) of a gradient applied to the fill of the TextFrame, in the format [x, y]. | TextFrame | ||
gradientStrokeAngle : Number [override]
The angle of a linear gradient applied to the stroke of the TextFrame. | TextFrame | ||
gradientStrokeLength : Object [override]
The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the TextFrame. | TextFrame | ||
gradientStrokeStart : Object [override]
The starting point (in page coordinates) of a gradient applied to the stroke of the TextFrame, in the format [x, y]. | TextFrame | ||
graphicLines : GraphicLines [read-only]
A collection of graphic lines. | TextFrame | ||
gridData : GridDataInformation [read-only]
Default grid properties. | TextFrame | ||
groups : Groups [read-only]
A collection of groups. | TextFrame | ||
hiddenTexts : HiddenTexts [read-only]
A collection of hidden text objects. | TextFrame | ||
horizontalScale : Number [override]
The horizontal scaling applied to the TextFrame. | TextFrame | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
id : Number [override] [read-only]
The unique ID of the TextFrame. | TextFrame | ||
index : Number [override] [read-only]
The index of the TextFrame within its containing object. | TextFrame | ||
insertionPoints : InsertionPoints [read-only]
A collection of insertion points. | TextFrame | ||
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | TextFrame | ||
itemLayer : Layer [override]
The layer that the TextFrame is on. | TextFrame | ||
label : String [override]
A property that can be set to any string. | TextFrame | ||
leftLineEnd : ArrowHead [override]
The arrowhead applied to the start of the path. | TextFrame | ||
lines : Lines [read-only]
A collection of lines. | TextFrame | ||
localDisplaySetting : DisplaySettingOptions [override]
Display performance options for the TextFrame. | TextFrame | ||
locked : Boolean [override]
If true, the TextFrame is locked. | TextFrame | ||
miterLimit : Number [override]
The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. | TextFrame | ||
multiStateObjects : MultiStateObjects [read-only]
A collection of multi-state objects. | TextFrame | ||
name : String [override]
The name of the TextFrame. | TextFrame | ||
nextTextFrame : Object
The next text frame in the thread. | TextFrame | ||
nonprinting : Boolean [override]
If true, the TextFrame does not print. | TextFrame | ||
notes : Notes [read-only]
A collection of notes. | TextFrame | ||
ovals : Ovals [read-only]
A collection of ellipses. | TextFrame | ||
overflows : Boolean [read-only]
If true, the story has overset text. | TextFrame | ||
overprintFill : Boolean [override]
If true, the TextFrame's fill color overprints any underlying objects. | TextFrame | ||
overprintGap : Boolean [override]
If true, the gap color overprints any underlying colors. | TextFrame | ||
overprintStroke : Boolean [override]
If true, the TextFrame's stroke color overprints any underlying objects. | TextFrame | ||
overridden : Boolean [override] [read-only]
If true, the object originated on a master spread and was overridden. | TextFrame | ||
overriddenMasterPageItem : Object [override] [read-only]
An object that originated on a master page and has been overridden. | TextFrame | ||
pageItems : PageItems [read-only]
The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type. | TextFrame | ||
paragraphs : Paragraphs [read-only]
A collection of paragraphs. | TextFrame | ||
parent : Object [override] [read-only]
The parent of the TextFrame (a Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, State, Character, PlaceGun or Snippet). | TextFrame | ||
parentPage : Page [override] [read-only]
The page on which this page item appears. | TextFrame | ||
parentStory : Story [read-only]
The story that contains the text. | TextFrame | ||
paths : Paths [read-only]
A collection of paths. | TextFrame | ||
polygons : Polygons [read-only]
A collection of polygons. | TextFrame | ||
preferences : Preferences [override] [read-only]
A collection of preferences objects. | TextFrame | ||
previousTextFrame : Object
The previous text frame in the thread. | TextFrame | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | TextFrame | ||
rectangles : Rectangles [read-only]
A collection of rectangles. | TextFrame | ||
rightLineEnd : ArrowHead [override]
The arrowhead applied to the end of the path. | TextFrame | ||
rotationAngle : Number [override]
The rotatation angle of the TextFrame. | TextFrame | ||
shearAngle : Number [override]
The skewing angle applied to the TextFrame. | TextFrame | ||
splineItems : SplineItems [read-only]
The spline items collection. | TextFrame | ||
startTextFrame : Object [read-only]
The first text frame in the thread. | TextFrame | ||
strokeAlignment : StrokeAlignment [override]
The stroke alignment applied to the TextFrame. | TextFrame | ||
strokeColor : Swatch [override]
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the TextFrame. | TextFrame | ||
strokeCornerAdjustment : StrokeCornerAdjustment [override]
The corner adjustment applied to the TextFrame. | TextFrame | ||
strokeDashAndGap : Object [override]
The dash and gap measurements that define the pattern of a custom dashed line. | TextFrame | ||
strokeTint : Number [override]
The percent of tint to use in object's stroke color. | TextFrame | ||
strokeTransparencySettings : StrokeTransparencySetting [override] [read-only]
Transparency settings for the stroke. | TextFrame | ||
strokeType : StrokeStyle [override]
The name of the stroke style to apply. | TextFrame | ||
strokeWeight : Object [override]
The weight (in points) to apply to the TextFrame's stroke. | TextFrame | ||
tables : Tables [read-only]
A collection of tables. | TextFrame | ||
textColumns : TextColumns [read-only]
A collection of text columns. | TextFrame | ||
textFrameIndex : Number [read-only]
The index of the text frame within the story. | TextFrame | ||
textFramePreferences : TextFramePreference [read-only]
Text frame preference settings. | TextFrame | ||
textFrames : TextFrames [read-only]
A collection of text frames. | TextFrame | ||
textPaths : TextPaths [read-only]
A collection of text paths. | TextFrame | ||
texts : Texts [read-only]
A collection of text objects. | TextFrame | ||
textStyleRanges : TextStyleRanges [read-only]
A collection of text style ranges. | TextFrame | ||
textVariableInstances : TextVariableInstances [read-only]
A collection of text variable instances. | TextFrame | ||
textWrapPreferences : TextWrapPreference [override] [read-only]
The text wrap preference properties that define the default formatting for wrapping text around objects. | TextFrame | ||
timingSettings : TimingSetting [override] [read-only]
The object timing settings. | TextFrame | ||
topLeftCornerOption : CornerOptions [override]
The shape to be applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes.Note: corner option differs from end join in which you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends on the stroke weight. | TextFrame | ||
topLeftCornerRadius : Object [override]
The radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes
| TextFrame | ||
topRightCornerOption : CornerOptions [override]
The shape to apply to the top right corner of rectangular shapes
| TextFrame | ||
topRightCornerRadius : Object [override]
The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
| TextFrame | ||
transparencySettings : TransparencySetting [override] [read-only]
Transparency settings. | TextFrame | ||
verticalScale : Number [override]
The vertical scaling applied to the TextFrame. | TextFrame | ||
visible : Boolean [override]
If true, the TextFrame is visible. | TextFrame | ||
visibleBounds : Object [override]
The bounds of the TextFrame including the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box. | TextFrame | ||
words : Words [read-only]
A collection of words. | TextFrame |
Method | Defined By | ||
---|---|---|---|
![]() | addEventListenerPageItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | PageItem | |
addEventListenerTextFrame(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | TextFrame | ||
Creates a new page item by combining the TextFrame with other objects. | TextFrame | ||
applyObjectStyle(usingParam:ObjectStyle = null, clearingOverridesParam:Boolean = true, clearingOverridesThroughRootObjectStyleParam:Boolean = false):void [override]
Applies the specified object style. | TextFrame | ||
asynchronousExportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, usingParam:PDFExportPreset = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):BackgroundTask [override]
asynchronously exports the object(s) to a file. | TextFrame | ||
autoTag():void [override]
Tag the object or the parent story using default tags defined in XML preference. | TextFrame | ||
bringForward():void
Brings the TextFrame forward one level in its layer. | TextFrame | ||
bringToFront(referenceParam:PageItem = null):void
Brings the TextFrame to the front of its layer or in front of a particular item. | TextFrame | ||
changeGlyph(reverseOrderParam:Boolean):Object
Finds glyphs that match the find what value and replaces the glyphs with the change to value. | TextFrame | ||
changeGrep(reverseOrderParam:Boolean):Object
Finds text that matches the find what value and replaces the text with the change to value. | TextFrame | ||
changeObject(reverseOrderParam:Boolean):Object [override]
Finds objects that match the find what value and replace the objects with the change to value. | TextFrame | ||
changeText(reverseOrderParam:Boolean):Object
Finds text that matches the find what value and replaces the text with the change to value. | TextFrame | ||
changeTransliterate(reverseOrderParam:Boolean):Object
Finds text that matches the find character type value and replaces the text with the change character type value. | TextFrame | ||
clearObjectStyleOverrides():void [override]
Clear overrides for object style
| TextFrame | ||
clearTransformations():void [override]
Clears transformations from the TextFrame. | TextFrame | ||
convertShape(givenParam:ConvertShapeOptions = null, numberOfSidesParam:Number, insetPercentageParam:Number, cornerRadiusParam:Object = null):void [override]
Converts the TextFrame to a different shape. | TextFrame | ||
createOutlines(deleteOriginalParam:Boolean = true):Object
Converts text to outlines. | TextFrame | ||
detach():void [override]
Detaches an overridden master page item from the master page. | TextFrame | ||
[override]
Duplicates the TextFrame at the specified location or offset. | TextFrame | ||
excludeOverlapPath(withParam:Array = null):PageItem
Creates a new page item by excluding the overlapping areas of the TextFrame and other objects. | TextFrame | ||
exportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, usingParam:PDFExportPreset = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void [override]
Exports the object(s) to a file. | TextFrame | ||
extractLabel(keyParam:String = null):String [override]
Gets the label value associated with the specified key. | TextFrame | ||
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
findGlyph(reverseOrderParam:Boolean):Object
Finds glyphs that match the find what value. | TextFrame | ||
findGrep(reverseOrderParam:Boolean):Object
Finds text that matches the find what value. | TextFrame | ||
findObject(reverseOrderParam:Boolean):Object [override]
Finds objects that match the find what value. | TextFrame | ||
findText(reverseOrderParam:Boolean):Object
Finds text that matches the find what value. | TextFrame | ||
findTransliterate(reverseOrderParam:Boolean):Object
Finds text that matches the find character type value. | TextFrame | ||
fit(givenParam:FitOptions = null):void [override]
Applies the specified fit option to content in a frame. | TextFrame | ||
[override]
Flips the TextFrame. | TextFrame | ||
![]() | 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 | |
getElements():Object [override]
Resolves the object specifier, creating an array of object references. | TextFrame | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | 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 | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
insertLabel(keyParam:String = null, valueParam:String = null):void [override]
Sets the label to the value associated with the specified key. | TextFrame | ||
intersectPath(withParam:Array = null):PageItem
Creates a new page item by intersecting the TextFrame with other objects. | TextFrame | ||
![]() | 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 | |
makeCompoundPath(withParam:Array = null):PageItem
Creates a compound path by combining the path(s) of the TextFrame with the paths of other objects. | TextFrame | ||
markup(usingParam:XMLElement = null):void [override]
Associates the page item with the specified XML element while preserving existing content. | TextFrame | ||
Creates a new page item by reverse subtracting the overlapping areas of the TextFrame and other objects. | TextFrame | ||
move(toParam:Object = null, byParam:Array = null):void [override]
Moves the TextFrame to a new location. | TextFrame | ||
[override]
Overrides a master page item and places the item on the document page as a new object. | TextFrame | ||
place(fileNameParam:File = null, showingOptionsParam:Boolean = false, withPropertiesParam:Object = null):Object [override]
Places the file. | TextFrame | ||
Create a linked story and place it into the target page item. | TextFrame | ||
placeXML(usingParam:XMLElement = null):void [override]
Places XML content into the specified object. | TextFrame | ||
recompose():void
Recomposes the text in the TextFrame. | TextFrame | ||
redefineScaling(toParam:Array = null):void [override]
Apply an item's scaling to its content if possible. | TextFrame | ||
reframe(inParam:Object = null, opposingCornersParam:Array = null):void [override]
Move the bounding box of the page item
| TextFrame | ||
releaseCompoundPath():Object
Releases a compound path. | TextFrame | ||
remove():void [override]
Deletes the TextFrame. | TextFrame | ||
![]() | removeEventListenerPageItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | PageItem | |
removeEventListenerTextFrame(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | TextFrame | ||
removeOverride():void [override]
Removes the override from a previously overridden master page item. | TextFrame | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
resize(inParam:Object = null, fromParam:Object = null, byParam:ResizeMethods = null, valuesParam:Array = null, resizeIndividuallyParam:Boolean = true, consideringRulerUnitsParam:Boolean = false):void [override]
Resize the page item. | TextFrame | ||
resolve(locationParam:Object = null, inParam:CoordinateSpaces = null, consideringRulerUnitsParam:Boolean = false):Object [override]
Get the coordinates of the given location in the specified coordinate system. | TextFrame | ||
select(existingSelectionParam:SelectionOptions = null):void [override]
Selects the object. | TextFrame | ||
sendBackward():void
Sends the TextFrame back one level in its layer. | TextFrame | ||
sendToBack(referenceParam:PageItem = null):void
Sends the TextFrame to the back of its layer or behind a particular item (must have same parent). | TextFrame | ||
[override]
Stores the object in the specified library. | TextFrame | ||
subtractPath(withParam:Array = null):PageItem
Creates a new page item by subtracting the overlapping areas of the TextFrame and other objects. | TextFrame | ||
toSpecifier():String [override]
Retrieves the object specifier. | TextFrame | ||
transform(inParam:CoordinateSpaces = null, fromParam:Object = null, withMatrixParam:Object = null, replacingCurrentParam:Object = null, consideringRulerUnitsParam:Boolean = false):void [override]
Transform the page item. | TextFrame | ||
transformAgain():Object [override]
Transforms the TextFrame using the last transformation performed on any object. | TextFrame | ||
transformAgainIndividually():Object [override]
Transforms the TextFrame using the last transformation performed on any TextFrame. | TextFrame | ||
transformSequenceAgain():Object [override]
Transforms the TextFrame using the last sequence of transform operations performed on any single object or performed at the same time on any group of objects. | TextFrame | ||
transformSequenceAgainIndividually():Object [override]
Transforms the TextFrame using the last sequence of transformations performed on any single object or performed at the same time on any group of objects. | TextFrame | ||
transformValuesOf(inParam:CoordinateSpaces = null):Object [override]
Get the transformation values of the page item. | TextFrame | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
absoluteFlip | property |
absoluteFlip:Flip
[override] Since : | CS5 |
Indicates whether the TextFrame has been flipped independently of its parent object and, if yes, the direction in which the TextFrame was flipped.
public function get absoluteFlip():Flip
public function set absoluteFlip(value:Flip):void
absoluteHorizontalScale | property |
absoluteHorizontalScale:Number
[override] Since : | CS5 |
The horizontal scale of the TextFrame relative to its containing object.
public function get absoluteHorizontalScale():Number
public function set absoluteHorizontalScale(value:Number):void
absoluteRotationAngle | property |
absoluteRotationAngle:Number
[override] Since : | CS5 |
The rotation angle of the TextFrame relative to its containing object. (Range: -360 to 360)
public function get absoluteRotationAngle():Number
public function set absoluteRotationAngle(value:Number):void
absoluteShearAngle | property |
absoluteShearAngle:Number
[override] Since : | CS5 |
The skewing angle of the TextFrame relative to its containing object. (Range: -360 to 360)
public function get absoluteShearAngle():Number
public function set absoluteShearAngle(value:Number):void
absoluteVerticalScale | property |
absoluteVerticalScale:Number
[override] Since : | CS5 |
The vertical scale of the TextFrame relative to its containing object.
public function get absoluteVerticalScale():Number
public function set absoluteVerticalScale(value:Number):void
AFTER_PLACE | property |
AFTER_PLACE:String
[read-only] Since : | CS5 |
Dispatched after a TextFrame is placed. This event bubbles. This event is not cancelable.
public static function get AFTER_PLACE():String
allArticles | property |
allArticles:Object
[read-only] [override] Since : | CS5.5 |
The list of all articles this page item is part of
public function get allArticles():Object
allGraphics | property |
allGraphics:Object
[read-only] [override] Since : | CS5 |
Lists all graphics contained by the TextFrame.
public function get allGraphics():Object
allowOverrides | property |
allowOverrides:Boolean
[override] Since : | CS5 |
If true, the master page item can be overridden.
public function get allowOverrides():Boolean
public function set allowOverrides(value:Boolean):void
allPageItems | property |
allPageItems:Object
[read-only] [override] Since : | CS5 |
Lists all page items contained by the TextFrame.
public function get allPageItems():Object
anchoredObjectSettings | property |
anchoredObjectSettings:AnchoredObjectSetting
[read-only] Since : | CS5 |
Anchored object settings.
public function get anchoredObjectSettings():AnchoredObjectSetting
animationSettings | property |
animationSettings:AnimationSetting
[read-only] [override] Since : | CS5 |
The page item animation settings.
public function get animationSettings():AnimationSetting
appliedObjectStyle | property |
appliedObjectStyle:ObjectStyle
[override] Since : | CS5 |
The object style applied to the TextFrame.
public function get appliedObjectStyle():ObjectStyle
public function set appliedObjectStyle(value:ObjectStyle):void
associatedXMLElement | property |
associatedXMLElement:XMLItem
[read-only] [override] Since : | CS5 |
The XML element associated with the TextFrame.
public function get associatedXMLElement():XMLItem
baselineFrameGridOptions | property |
baselineFrameGridOptions:BaselineFrameGridOption
[read-only] Since : | CS5 |
Baseline frame grid option settings.
public function get baselineFrameGridOptions():BaselineFrameGridOption
BEFORE_PLACE | property |
BEFORE_PLACE:String
[read-only] Since : | CS5 |
Dispatched before a TextFrame is placed. This event bubbles. This event is cancelable.
public static function get BEFORE_PLACE():String
bottomLeftCornerOption | property |
bottomLeftCornerOption:CornerOptions
[override] Since : | CS5 |
The shape to apply to the bottom left corner of rectangular shapes.
public function get bottomLeftCornerOption():CornerOptions
public function set bottomLeftCornerOption(value:CornerOptions):void
bottomLeftCornerRadius | property |
bottomLeftCornerRadius:Object
[override] Since : | CS5 |
The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
public function get bottomLeftCornerRadius():Object
public function set bottomLeftCornerRadius(value:Object):void
bottomRightCornerOption | property |
bottomRightCornerOption:CornerOptions
[override] Since : | CS5 |
The shape to apply to the bottom right corner of rectangular shapes.
public function get bottomRightCornerOption():CornerOptions
public function set bottomRightCornerOption(value:CornerOptions):void
bottomRightCornerRadius | property |
bottomRightCornerRadius:Object
[override] Since : | CS5 |
The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
public function get bottomRightCornerRadius():Object
public function set bottomRightCornerRadius(value:Object):void
buttons | property |
buttons:Buttons
[read-only] Since : | CS5 |
A collection of buttons.
public function get buttons():Buttons
characters | property |
characters:Characters
[read-only] Since : | CS5 |
A collection of characters.
public function get characters():Characters
contents | property |
contents:Object
Since : | CS5 |
The contents of the text frame. Can return: String, TextFrameContents enumerator or SpecialCharacters enumerator.
public function get contents():Object
public function set contents(value:Object):void
contentTransparencySettings | property |
contentTransparencySettings:ContentTransparencySetting
[read-only] [override] Since : | CS5 |
Transparency settings for the content of the TextFrame.
public function get contentTransparencySettings():ContentTransparencySetting
contentType | property |
contentType:ContentType
Since : | CS5 |
The type of content that a frame can contain.
public function get contentType():ContentType
public function set contentType(value:ContentType):void
endCap | property |
endCap:EndCap
[override] Since : | CS5 |
The end shape of an open path.
public function get endCap():EndCap
public function set endCap(value:EndCap):void
endJoin | property |
endJoin:EndJoin
[override] Since : | CS5 |
The corner join applied to the TextFrame.
public function get endJoin():EndJoin
public function set endJoin(value:EndJoin):void
endTextFrame | property |
endTextFrame:Object
[read-only] Since : | CS5 |
The last text frame in the thread. Can return: TextFrame or TextPath.
public function get endTextFrame():Object
epstexts | property |
epstexts:EPSTexts
[read-only] Since : | CS5 |
EPSTexts
public function get epstexts():EPSTexts
eventListeners | property |
eventListeners:EventListeners
[read-only] [override] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] [override] Since : | CS5 |
A collection of events.
public function get events():Events
fillColor | property |
fillColor:Swatch
[override] Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the fill of the TextFrame. . Can also accept: String.
public function get fillColor():Swatch
public function set fillColor(value:Swatch):void
fillTint | property |
fillTint:Number
[override] Since : | CS5 |
The percent of tint to use in the TextFrame's fill color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
public function get fillTint():Number
public function set fillTint(value:Number):void
fillTransparencySettings | property |
fillTransparencySettings:FillTransparencySetting
[read-only] [override] Since : | CS5 |
Transparency settings for the fill applied to the TextFrame.
public function get fillTransparencySettings():FillTransparencySetting
flip | property |
flip:Flip
[override] Since : | CS5 |
The direction in which to flip the printed image.
public function get flip():Flip
public function set flip(value:Flip):void
footnotes | property |
footnotes:Footnotes
[read-only] Since : | CS5 |
A collection of footnotes.
public function get footnotes():Footnotes
formFields | property |
formFields:FormFields
[read-only] Since : | CS5 |
A collection of form fields.
public function get formFields():FormFields
gapColor | property |
gapColor:Swatch
[override] Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type.
public function get gapColor():Swatch
public function set gapColor(value:Swatch):void
gapTint | property |
gapTint:Number
[override] Since : | CS5 |
The tint as a percentage of the gap color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
public function get gapTint():Number
public function set gapTint(value:Number):void
geometricBounds | property |
geometricBounds:Object
[override] Since : | CS5 |
The bounds of the TextFrame excluding the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.
public function get geometricBounds():Object
public function set geometricBounds(value:Object):void
gradientFillAngle | property |
gradientFillAngle:Number
[override] Since : | CS5 |
The angle of a linear gradient applied to the fill of the TextFrame. (Range: -180 to 180)
public function get gradientFillAngle():Number
public function set gradientFillAngle(value:Number):void
gradientFillLength | property |
gradientFillLength:Object
[override] Since : | CS5 |
The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the TextFrame.
public function get gradientFillLength():Object
public function set gradientFillLength(value:Object):void
gradientFillStart | property |
gradientFillStart:Object
[override] Since : | CS5 |
The starting point (in page coordinates) of a gradient applied to the fill of the TextFrame, in the format [x, y].
public function get gradientFillStart():Object
public function set gradientFillStart(value:Object):void
gradientStrokeAngle | property |
gradientStrokeAngle:Number
[override] Since : | CS5 |
The angle of a linear gradient applied to the stroke of the TextFrame. (Range: -180 to 180)
public function get gradientStrokeAngle():Number
public function set gradientStrokeAngle(value:Number):void
gradientStrokeLength | property |
gradientStrokeLength:Object
[override] Since : | CS5 |
The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the TextFrame.
public function get gradientStrokeLength():Object
public function set gradientStrokeLength(value:Object):void
gradientStrokeStart | property |
gradientStrokeStart:Object
[override] Since : | CS5 |
The starting point (in page coordinates) of a gradient applied to the stroke of the TextFrame, in the format [x, y].
public function get gradientStrokeStart():Object
public function set gradientStrokeStart(value:Object):void
graphicLines | property |
graphicLines:GraphicLines
[read-only] Since : | CS5 |
A collection of graphic lines.
public function get graphicLines():GraphicLines
gridData | property |
gridData:GridDataInformation
[read-only] Since : | CS5 |
Default grid properties. Note: Applies to named, layout, and frame (story) grids.
public function get gridData():GridDataInformation
groups | property |
groups:Groups
[read-only] Since : | CS5 |
A collection of groups.
public function get groups():Groups
hiddenTexts | property |
hiddenTexts:HiddenTexts
[read-only] Since : | CS5 |
A collection of hidden text objects.
public function get hiddenTexts():HiddenTexts
horizontalScale | property |
horizontalScale:Number
[override] Since : | CS5 |
The horizontal scaling applied to the TextFrame.
public function get horizontalScale():Number
public function set horizontalScale(value:Number):void
id | property |
id:Number
[read-only] [override] Since : | CS5 |
The unique ID of the TextFrame.
public function get id():Number
index | property |
index:Number
[read-only] [override] Since : | CS5 |
The index of the TextFrame within its containing object.
public function get index():Number
insertionPoints | property |
insertionPoints:InsertionPoints
[read-only] Since : | CS5 |
A collection of insertion points.
public function get insertionPoints():InsertionPoints
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
itemLayer | property |
itemLayer:Layer
[override] Since : | CS5 |
The layer that the TextFrame is on.
public function get itemLayer():Layer
public function set itemLayer(value:Layer):void
label | property |
label:String
[override] Since : | CS5 |
A property that can be set to any string.
public function get label():String
public function set label(value:String):void
leftLineEnd | property |
leftLineEnd:ArrowHead
[override] Since : | CS5 |
The arrowhead applied to the start of the path.
public function get leftLineEnd():ArrowHead
public function set leftLineEnd(value:ArrowHead):void
lines | property |
lines:Lines
[read-only] Since : | CS5 |
A collection of lines.
public function get lines():Lines
localDisplaySetting | property |
localDisplaySetting:DisplaySettingOptions
[override] Since : | CS5 |
Display performance options for the TextFrame.
public function get localDisplaySetting():DisplaySettingOptions
public function set localDisplaySetting(value:DisplaySettingOptions):void
locked | property |
locked:Boolean
[override] Since : | CS5 |
If true, the TextFrame is locked.
public function get locked():Boolean
public function set locked(value:Boolean):void
miterLimit | property |
miterLimit:Number
[override] Since : | CS5 |
The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join.
public function get miterLimit():Number
public function set miterLimit(value:Number):void
multiStateObjects | property |
multiStateObjects:MultiStateObjects
[read-only] Since : | CS5 |
A collection of multi-state objects.
public function get multiStateObjects():MultiStateObjects
name | property |
name:String
[override] Since : | CS5 |
The name of the TextFrame.
public function get name():String
public function set name(value:String):void
nextTextFrame | property |
nextTextFrame:Object
Since : | CS5 |
The next text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator.
public function get nextTextFrame():Object
public function set nextTextFrame(value:Object):void
nonprinting | property |
nonprinting:Boolean
[override] Since : | CS5 |
If true, the TextFrame does not print.
public function get nonprinting():Boolean
public function set nonprinting(value:Boolean):void
notes | property |
notes:Notes
[read-only] Since : | CS5 |
A collection of notes.
public function get notes():Notes
ovals | property |
ovals:Ovals
[read-only] Since : | CS5 |
A collection of ellipses.
public function get ovals():Ovals
overflows | property |
overflows:Boolean
[read-only] Since : | CS5 |
If true, the story has overset text.
public function get overflows():Boolean
overprintFill | property |
overprintFill:Boolean
[override] Since : | CS5 |
If true, the TextFrame's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.
public function get overprintFill():Boolean
public function set overprintFill(value:Boolean):void
overprintGap | property |
overprintGap:Boolean
[override] Since : | CS5 |
If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.
public function get overprintGap():Boolean
public function set overprintGap(value:Boolean):void
overprintStroke | property |
overprintStroke:Boolean
[override] Since : | CS5 |
If true, the TextFrame's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.
public function get overprintStroke():Boolean
public function set overprintStroke(value:Boolean):void
overridden | property |
overridden:Boolean
[read-only] [override] Since : | CS5 |
If true, the object originated on a master spread and was overridden. If false, the object either originated on a master spread and was not overridden, or the object did not originate on a master page.
public function get overridden():Boolean
overriddenMasterPageItem | property |
overriddenMasterPageItem:Object
[read-only] [override] Since : | CS5 |
An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound.
public function get overriddenMasterPageItem():Object
pageItems | property |
pageItems:PageItems
[read-only] Since : | CS5 |
The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.
public function get pageItems():PageItems
paragraphs | property |
paragraphs:Paragraphs
[read-only] Since : | CS5 |
A collection of paragraphs.
public function get paragraphs():Paragraphs
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the TextFrame (a Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, State, Character, PlaceGun or Snippet).
public function get parent():Object
parentPage | property |
parentPage:Page
[read-only] [override] Since : | CS5 |
The page on which this page item appears.
public function get parentPage():Page
parentStory | property |
parentStory:Story
[read-only] Since : | CS5 |
The story that contains the text.
public function get parentStory():Story
paths | property |
paths:Paths
[read-only] Since : | CS5 |
A collection of paths.
public function get paths():Paths
polygons | property |
polygons:Polygons
[read-only] Since : | CS5 |
A collection of polygons.
public function get polygons():Polygons
preferences | property |
preferences:Preferences
[read-only] [override] Since : | CS5 |
A collection of preferences objects.
public function get preferences():Preferences
previousTextFrame | property |
previousTextFrame:Object
Since : | CS5 |
The previous text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator.
public function get previousTextFrame():Object
public function set previousTextFrame(value:Object):void
properties | property |
properties:Object
[override] Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
rectangles | property |
rectangles:Rectangles
[read-only] Since : | CS5 |
A collection of rectangles.
public function get rectangles():Rectangles
rightLineEnd | property |
rightLineEnd:ArrowHead
[override] Since : | CS5 |
The arrowhead applied to the end of the path.
public function get rightLineEnd():ArrowHead
public function set rightLineEnd(value:ArrowHead):void
rotationAngle | property |
rotationAngle:Number
[override] Since : | CS5 |
The rotatation angle of the TextFrame. (Range: -360 to 360)
public function get rotationAngle():Number
public function set rotationAngle(value:Number):void
shearAngle | property |
shearAngle:Number
[override] Since : | CS5 |
The skewing angle applied to the TextFrame. (Range: -360 to 360)
public function get shearAngle():Number
public function set shearAngle(value:Number):void
splineItems | property |
splineItems:SplineItems
[read-only] Since : | CS5 |
The spline items collection.
public function get splineItems():SplineItems
startTextFrame | property |
startTextFrame:Object
[read-only] Since : | CS5 |
The first text frame in the thread. Can return: TextFrame or TextPath.
public function get startTextFrame():Object
strokeAlignment | property |
strokeAlignment:StrokeAlignment
[override] Since : | CS5 |
The stroke alignment applied to the TextFrame.
public function get strokeAlignment():StrokeAlignment
public function set strokeAlignment(value:StrokeAlignment):void
strokeColor | property |
strokeColor:Swatch
[override] Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the TextFrame. Can also accept: String.
public function get strokeColor():Swatch
public function set strokeColor(value:Swatch):void
strokeCornerAdjustment | property |
strokeCornerAdjustment:StrokeCornerAdjustment
[override] Since : | CS5 |
The corner adjustment applied to the TextFrame.
public function get strokeCornerAdjustment():StrokeCornerAdjustment
public function set strokeCornerAdjustment(value:StrokeCornerAdjustment):void
strokeDashAndGap | property |
strokeDashAndGap:Object
[override] Since : | CS5 |
The dash and gap measurements that define the pattern of a custom dashed line. Define up to six values (in points) in the format [dash1, gap1, dash2, gap2, dash3, gap3].
public function get strokeDashAndGap():Object
public function set strokeDashAndGap(value:Object):void
strokeTint | property |
strokeTint:Number
[override] Since : | CS5 |
The percent of tint to use in object's stroke color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
public function get strokeTint():Number
public function set strokeTint(value:Number):void
strokeTransparencySettings | property |
strokeTransparencySettings:StrokeTransparencySetting
[read-only] [override] Since : | CS5 |
Transparency settings for the stroke.
public function get strokeTransparencySettings():StrokeTransparencySetting
strokeType | property |
strokeType:StrokeStyle
[override] Since : | CS5 |
The name of the stroke style to apply. Can also accept: String.
public function get strokeType():StrokeStyle
public function set strokeType(value:StrokeStyle):void
strokeWeight | property |
strokeWeight:Object
[override] Since : | CS5 |
The weight (in points) to apply to the TextFrame's stroke.
public function get strokeWeight():Object
public function set strokeWeight(value:Object):void
tables | property |
tables:Tables
[read-only] Since : | CS5 |
A collection of tables.
public function get tables():Tables
textColumns | property |
textColumns:TextColumns
[read-only] Since : | CS5 |
A collection of text columns.
public function get textColumns():TextColumns
textFrameIndex | property |
textFrameIndex:Number
[read-only] Since : | CS5 |
The index of the text frame within the story.
public function get textFrameIndex():Number
textFramePreferences | property |
textFramePreferences:TextFramePreference
[read-only] Since : | CS5 |
Text frame preference settings.
public function get textFramePreferences():TextFramePreference
textFrames | property |
textFrames:TextFrames
[read-only] Since : | CS5 |
A collection of text frames.
public function get textFrames():TextFrames
textPaths | property |
textPaths:TextPaths
[read-only] Since : | CS5 |
A collection of text paths.
public function get textPaths():TextPaths
texts | property |
texts:Texts
[read-only] Since : | CS5 |
A collection of text objects.
public function get texts():Texts
textStyleRanges | property |
textStyleRanges:TextStyleRanges
[read-only] Since : | CS5 |
A collection of text style ranges.
public function get textStyleRanges():TextStyleRanges
textVariableInstances | property |
textVariableInstances:TextVariableInstances
[read-only] Since : | CS5 |
A collection of text variable instances.
public function get textVariableInstances():TextVariableInstances
textWrapPreferences | property |
textWrapPreferences:TextWrapPreference
[read-only] [override] Since : | CS5 |
The text wrap preference properties that define the default formatting for wrapping text around objects.
public function get textWrapPreferences():TextWrapPreference
timingSettings | property |
timingSettings:TimingSetting
[read-only] [override] Since : | CS5 |
The object timing settings.
public function get timingSettings():TimingSetting
topLeftCornerOption | property |
topLeftCornerOption:CornerOptions
[override] Since : | CS5 |
The shape to be applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes.Note: corner option differs from end join in which you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends on the stroke weight.
public function get topLeftCornerOption():CornerOptions
public function set topLeftCornerOption(value:CornerOptions):void
topLeftCornerRadius | property |
topLeftCornerRadius:Object
[override] Since : | CS5 |
The radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes
public function get topLeftCornerRadius():Object
public function set topLeftCornerRadius(value:Object):void
topRightCornerOption | property |
topRightCornerOption:CornerOptions
[override] Since : | CS5 |
The shape to apply to the top right corner of rectangular shapes
public function get topRightCornerOption():CornerOptions
public function set topRightCornerOption(value:CornerOptions):void
topRightCornerRadius | property |
topRightCornerRadius:Object
[override] Since : | CS5 |
The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
public function get topRightCornerRadius():Object
public function set topRightCornerRadius(value:Object):void
transparencySettings | property |
transparencySettings:TransparencySetting
[read-only] [override] Since : | CS5 |
Transparency settings.
public function get transparencySettings():TransparencySetting
verticalScale | property |
verticalScale:Number
[override] Since : | CS5 |
The vertical scaling applied to the TextFrame.
public function get verticalScale():Number
public function set verticalScale(value:Number):void
visible | property |
visible:Boolean
[override] Since : | CS5 |
If true, the TextFrame is visible.
public function get visible():Boolean
public function set visible(value:Boolean):void
visibleBounds | property |
visibleBounds:Object
[override] Since : | CS5 |
The bounds of the TextFrame including the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.
public function get visibleBounds():Object
public function set visibleBounds(value:Object):void
words | property |
words:Words
[read-only] Since : | CS5 |
A collection of words.
public function get words():Words
addEventListenerTextFrame | () | method |
public function addEventListenerTextFrame(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
Adds an event listener.
Parameters
eventTypeParam:String (default = null ) — (String) The event type.
| |
handlerParam:Object (default = null ) — (Object) The event handler. Can accept: File or JavaScript Function.
| |
capturesParam:Boolean (default = false ) — (Boolean) This parameter is obsolete. (Optional)
|
EventListener |
addPath | () | method |
public function addPath(withParam:Array = null):PageItem
Since : | CS5 |
Creates a new page item by combining the TextFrame with other objects. Deletes the objects if they do not intersect.
Parameters
withParam:Array (default = null ) — (Array) The object(s) to add.
|
PageItem |
applyObjectStyle | () | method |
override public function applyObjectStyle(usingParam:ObjectStyle = null, clearingOverridesParam:Boolean = true, clearingOverridesThroughRootObjectStyleParam:Boolean = false):void
Since : | CS5 |
Applies the specified object style.
Parameters
usingParam:ObjectStyle (default = null ) — (ObjectStyle) The object style to apply.
| |
clearingOverridesParam:Boolean (default = true ) — (Boolean) If true, clears the TextFrame's existing attributes before applying the style. (Optional)
| |
clearingOverridesThroughRootObjectStyleParam:Boolean (default = false ) — (Boolean) If true, clears attributes and formatting applied to the TextFrame that are not defined in the object style. (Optional)
|
asynchronousExportFile | () | method |
override public function asynchronousExportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, usingParam:PDFExportPreset = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):BackgroundTask
Since : | CS5 |
asynchronously exports the object(s) to a file.
Parameters
formatParam:Object (default = null ) — (Object) The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String.
| |
toParam:File (default = null ) — (File) The path to the export file.
| |
showingOptionsParam:Boolean (default = false ) — (Boolean) If true, displays the export options dialog. (Optional)
| |
usingParam:PDFExportPreset (default = null ) — (PDFExportPreset) The export style. (Optional)
| |
versionCommentsParam:String (default = null ) — (String) The comment for this version. (Optional)
| |
forceSaveParam:Boolean (default = false ) — (Boolean) If true, forcibly saves a version. (Optional)
|
BackgroundTask |
autoTag | () | method |
override public function autoTag():void
Since : | CS5 |
Tag the object or the parent story using default tags defined in XML preference.
bringForward | () | method |
public function bringForward():void
Since : | CS5 |
Brings the TextFrame forward one level in its layer.
bringToFront | () | method |
public function bringToFront(referenceParam:PageItem = null):void
Since : | CS5 |
Brings the TextFrame to the front of its layer or in front of a particular item.
Parameters
referenceParam:PageItem (default = null ) — (PageItem) The reference object to bring the object in front of (must have same parent) (Optional)
|
changeGlyph | () | method |
public function changeGlyph(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds glyphs that match the find what value and replaces the glyphs with the change to value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
changeGrep | () | method |
public function changeGrep(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds text that matches the find what value and replaces the text with the change to value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
changeObject | () | method |
override public function changeObject(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds objects that match the find what value and replace the objects with the change to value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
changeText | () | method |
public function changeText(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds text that matches the find what value and replaces the text with the change to value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
changeTransliterate | () | method |
public function changeTransliterate(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds text that matches the find character type value and replaces the text with the change character type value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
clearObjectStyleOverrides | () | method |
override public function clearObjectStyleOverrides():void
Since : | CS5 |
Clear overrides for object style
clearTransformations | () | method |
override public function clearTransformations():void
Since : | CS5 |
Clears transformations from the TextFrame. Transformations include rotation, scaling, flipping, fitting, and shearing.
convertShape | () | method |
override public function convertShape(givenParam:ConvertShapeOptions = null, numberOfSidesParam:Number, insetPercentageParam:Number, cornerRadiusParam:Object = null):void
Since : | CS5 |
Converts the TextFrame to a different shape.
Parameters
givenParam:ConvertShapeOptions (default = null ) — (ConvertShapeOptions) The TextFrame's new shape.
| |
numberOfSidesParam:Number (default = NaN ) — (Number) The number of sides for the resulting polygon. (Range: 3 to 100) (Optional)
| |
insetPercentageParam:Number (default = NaN ) — (Number) The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional)
| |
cornerRadiusParam:Object (default = null ) — (Object) The corner radius of the resulting rectangle. (Optional)
|
createOutlines | () | method |
public function createOutlines(deleteOriginalParam:Boolean = true):Object
Since : | CS5 |
Converts text to outlines. Each line of text becomes a polygon object. When the converted text is a single letter that has no internal spaces or detached parts, the polygon contains only a single path. Note: To determine whether a font allows the creation of outlines, see allow outlines.
Parameters
deleteOriginalParam:Boolean (default = true ) — (Boolean) If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional)
|
Object |
detach | () | method |
override public function detach():void
Since : | CS5 |
Detaches an overridden master page item from the master page.
duplicate | () | method |
override public function duplicate(toParam:Object = null, byParam:Array = null):PageItem
Since : | CS5 |
Duplicates the TextFrame at the specified location or offset.
Parameters
toParam:Object (default = null ) — (Object) The location of the new TextFrame, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
| |
byParam:Array (default = null ) — (Array) Amount by which to offset the new TextFrame from the original TextFrame's position. (Optional)
|
PageItem |
excludeOverlapPath | () | method |
public function excludeOverlapPath(withParam:Array = null):PageItem
Since : | CS5 |
Creates a new page item by excluding the overlapping areas of the TextFrame and other objects.
Parameters
withParam:Array (default = null ) — (Array) The object(s) to exclude.
|
PageItem |
exportFile | () | method |
override public function exportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, usingParam:PDFExportPreset = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Since : | CS5 |
Exports the object(s) to a file.
Parameters
formatParam:Object (default = null ) — (Object) The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String.
| |
toParam:File (default = null ) — (File) The path to the export file.
| |
showingOptionsParam:Boolean (default = false ) — (Boolean) If true, displays the export options dialog. (Optional)
| |
usingParam:PDFExportPreset (default = null ) — (PDFExportPreset) The export style. (Optional)
| |
versionCommentsParam:String (default = null ) — (String) The comment for this version. (Optional)
| |
forceSaveParam:Boolean (default = false ) — (Boolean) If true, forcibly saves a version. (Optional)
|
extractLabel | () | method |
override public function extractLabel(keyParam:String = null):String
Since : | CS5 |
Gets the label value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
|
String |
findGlyph | () | method |
public function findGlyph(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds glyphs that match the find what value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
findGrep | () | method |
public function findGrep(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds text that matches the find what value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
findObject | () | method |
override public function findObject(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds objects that match the find what value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
findText | () | method |
public function findText(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds text that matches the find what value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
findTransliterate | () | method |
public function findTransliterate(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds text that matches the find character type value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
fit | () | method |
override public function fit(givenParam:FitOptions = null):void
Since : | CS5 |
Applies the specified fit option to content in a frame.
Parameters
givenParam:FitOptions (default = null ) — (FitOptions) The fit option to use.
|
flipItem | () | method |
override public function flipItem(givenParam:Flip = null, aroundParam:Object = null):void
Since : | CS5 |
Flips the TextFrame.
Parameters
givenParam:Flip (default = null ) — (Flip) The axis around which to flip the TextFrame.
| |
aroundParam:Object (default = null ) — (Object) The point around which to flip the TextFrame. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)
|
getElements | () | method |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
insertLabel | () | method |
override public function insertLabel(keyParam:String = null, valueParam:String = null):void
Since : | CS5 |
Sets the label to the value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
| |
valueParam:String (default = null ) — (String) The value.
|
intersectPath | () | method |
public function intersectPath(withParam:Array = null):PageItem
Since : | CS5 |
Creates a new page item by intersecting the TextFrame with other objects. Returns an error if the objects do not intersect.
Parameters
withParam:Array (default = null ) — (Array) The object(s) with which to intersect.
|
PageItem |
makeCompoundPath | () | method |
public function makeCompoundPath(withParam:Array = null):PageItem
Since : | CS5 |
Creates a compound path by combining the path(s) of the TextFrame with the paths of other objects.
Parameters
withParam:Array (default = null ) — (Array) The other objects whose paths to include in the new compound path.
|
PageItem |
markup | () | method |
override public function markup(usingParam:XMLElement = null):void
Since : | CS5 |
Associates the page item with the specified XML element while preserving existing content.
Parameters
usingParam:XMLElement (default = null ) — (XMLElement) The XML element.
|
minusBack | () | method |
public function minusBack(withParam:Array = null):PageItem
Since : | CS5 |
Creates a new page item by reverse subtracting the overlapping areas of the TextFrame and other objects.
Parameters
withParam:Array (default = null ) — (Array) The object(s) to reverse subtract.
|
PageItem |
move | () | method |
override public function move(toParam:Object = null, byParam:Array = null):void
Since : | CS5 |
Moves the TextFrame to a new location. Note: Either the 'to' or 'by' parameter is required; if both parameters are defined, only the to value is used.
Parameters
toParam:Object (default = null ) — (Object) The new location of the TextFrame,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
| |
byParam:Array (default = null ) — (Array) The amount (in measurement units) to move the TextFrame relative to its current position, in the format (x, y). (Optional)
|
override | () | method |
override public function override(destinationPageParam:Page = null):Object
Since : | CS5 |
Overrides a master page item and places the item on the document page as a new object.
Parameters
destinationPageParam:Page (default = null ) — (Page) The document page that contains the master page item to override.
|
Object |
place | () | method |
override public function place(fileNameParam:File = null, showingOptionsParam:Boolean = false, withPropertiesParam:Object = null):Object
Since : | CS5 |
Places the file.
Parameters
fileNameParam:File (default = null ) — (File) The file to place
| |
showingOptionsParam:Boolean (default = false ) — (Boolean) Whether to display the import options dialog (Optional)
| |
withPropertiesParam:Object (default = null ) — (Object) Initial values for properties of the placed object(s) (Optional)
|
Object |
placeAndLink | () | method |
public function placeAndLink(parentStoryParam:Story = null, showingOptionsParam:Boolean = false):Story
Since : | CS5.5 |
Create a linked story and place it into the target page item.
Parameters
parentStoryParam:Story (default = null ) — (Story) The story to place and link from.
| |
showingOptionsParam:Boolean (default = false ) — (Boolean) Whether to display the link options dialog (Optional)
|
Story |
placeXML | () | method |
override public function placeXML(usingParam:XMLElement = null):void
Since : | CS5 |
Places XML content into the specified object. Note: Replaces any existing content.
Parameters
usingParam:XMLElement (default = null ) — (XMLElement) The XML element whose content you want to place.
|
recompose | () | method |
public function recompose():void
Since : | CS5 |
Recomposes the text in the TextFrame.
redefineScaling | () | method |
override public function redefineScaling(toParam:Array = null):void
Since : | CS5 |
Apply an item's scaling to its content if possible.
Parameters
toParam:Array (default = null ) — (Array) The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional)
|
reframe | () | method |
override public function reframe(inParam:Object = null, opposingCornersParam:Array = null):void
Since : | CS5 |
Move the bounding box of the page item
Parameters
inParam:Object (default = null ) — (Object) The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.
| |
opposingCornersParam:Array (default = null ) — (Array) Opposing corners of new bounding box in the given coordinate space
|
releaseCompoundPath | () | method |
public function releaseCompoundPath():Object
Since : | CS5 |
Releases a compound path.
ReturnsObject |
remove | () | method |
override public function remove():void
Since : | CS5 |
Deletes the TextFrame.
removeEventListenerTextFrame | () | method |
public function removeEventListenerTextFrame(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
Removes the event listener.
Parameters
eventTypeParam:String (default = null ) — (String) The registered event type.
| |
handlerParam:Object (default = null ) — (Object) The registered event handler. Can accept: File or JavaScript Function.
| |
capturesParam:Boolean (default = false ) — (Boolean) This parameter is obsolete. (Optional)
|
Boolean |
removeOverride | () | method |
override public function removeOverride():void
Since : | CS5 |
Removes the override from a previously overridden master page item.
resize | () | method |
override public function resize(inParam:Object = null, fromParam:Object = null, byParam:ResizeMethods = null, valuesParam:Array = null, resizeIndividuallyParam:Boolean = true, consideringRulerUnitsParam:Boolean = false):void
Since : | CS5 |
Resize the page item.
Parameters
inParam:Object (default = null ) — (Object) The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.
| |
fromParam:Object (default = null ) — (Object) The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
| |
byParam:ResizeMethods (default = null ) — (ResizeMethods) How the current dimensions are affected by the given values
| |
valuesParam:Array (default = null ) — (Array) The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators.
| |
resizeIndividuallyParam:Boolean (default = true ) — (Boolean) If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional)
| |
consideringRulerUnitsParam:Boolean (default = false ) — (Boolean) If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional)
|
resolve | () | method |
override public function resolve(locationParam:Object = null, inParam:CoordinateSpaces = null, consideringRulerUnitsParam:Boolean = false):Object
Since : | CS5 |
Get the coordinates of the given location in the specified coordinate system.
Parameters
locationParam:Object (default = null ) — (Object) The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
| |
inParam:CoordinateSpaces (default = null ) — (CoordinateSpaces) The coordinate space to use.
| |
consideringRulerUnitsParam:Boolean (default = false ) — (Boolean) If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional)
|
Object |
select | () | method |
override public function select(existingSelectionParam:SelectionOptions = null):void
Since : | CS5 |
Selects the object.
Parameters
existingSelectionParam:SelectionOptions (default = null ) — (SelectionOptions) The selection status of the TextFrame in relation to previously selected objects. (Optional)
|
sendBackward | () | method |
public function sendBackward():void
Since : | CS5 |
Sends the TextFrame back one level in its layer.
sendToBack | () | method |
public function sendToBack(referenceParam:PageItem = null):void
Since : | CS5 |
Sends the TextFrame to the back of its layer or behind a particular item (must have same parent).
Parameters
referenceParam:PageItem (default = null ) — (PageItem) The reference object to send the object behind (Optional)
|
store | () | method |
override public function store(usingParam:Library = null, withPropertiesParam:Object = null):Asset
Since : | CS5 |
Stores the object in the specified library.
Parameters
usingParam:Library (default = null ) — (Library) The library in which to store the object.
| |
withPropertiesParam:Object (default = null ) — (Object) Initial values for properties of the new TextFrame (Optional)
|
Asset |
subtractPath | () | method |
public function subtractPath(withParam:Array = null):PageItem
Since : | CS5 |
Creates a new page item by subtracting the overlapping areas of the TextFrame and other objects.
Parameters
withParam:Array (default = null ) — (Array) The object(s) to subtract.
|
PageItem |
toSpecifier | () | method |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |
transform | () | method |
override public function transform(inParam:CoordinateSpaces = null, fromParam:Object = null, withMatrixParam:Object = null, replacingCurrentParam:Object = null, consideringRulerUnitsParam:Boolean = false):void
Since : | CS5 |
Transform the page item.
Parameters
inParam:CoordinateSpaces (default = null ) — (CoordinateSpaces) The coordinate space to use
| |
fromParam:Object (default = null ) — (Object) The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
| |
withMatrixParam:Object (default = null ) — (Object) Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.
| |
replacingCurrentParam:Object (default = null ) — (Object) Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional)
| |
consideringRulerUnitsParam:Boolean (default = false ) — (Boolean) If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional)
|
transformAgain | () | method |
override public function transformAgain():Object
Since : | CS5 |
Transforms the TextFrame using the last transformation performed on any object. Transformations include moving, rotating, shearing, scaling, and flipping.
ReturnsObject |
transformAgainIndividually | () | method |
override public function transformAgainIndividually():Object
Since : | CS5 |
Transforms the TextFrame using the last transformation performed on any TextFrame. Transformations include moving, rotating, shearing, scaling, and flipping.
ReturnsObject |
transformSequenceAgain | () | method |
override public function transformSequenceAgain():Object
Since : | CS5 |
Transforms the TextFrame using the last sequence of transform operations performed on any single object or performed at the same time on any group of objects. Transformations include moving, rotating, shearing, scaling, and flipping.
ReturnsObject |
transformSequenceAgainIndividually | () | method |
override public function transformSequenceAgainIndividually():Object
Since : | CS5 |
Transforms the TextFrame using the last sequence of transformations performed on any single object or performed at the same time on any group of objects. Transformations include moving, rotating, shearing, scaling, and flipping.
ReturnsObject |
transformValuesOf | () | method |
override public function transformValuesOf(inParam:CoordinateSpaces = null):Object
Since : | CS5 |
Get the transformation values of the page item.
Parameters
inParam:CoordinateSpaces (default = null ) — (CoordinateSpaces) The coordinate space to use
|
Object |