Package | com.adobe.illustrator |
Class | public class TextRange |
Inheritance | TextRange ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
characterAttributes : CharacterAttributes [read-only]
The character properties for the text range. | TextRange | ||
characterOffset : Number
Offset of the first character of the range from the beginning of the story, in characters. | TextRange | ||
characters : Characters [read-only]
All the characters in this text range. | TextRange | ||
characterStyles : CharacterStyles [read-only]
List of referenced character styles in the text range. | TextRange | ||
contents : String
The text string. | TextRange | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
insertionPoints : InsertionPoints [read-only]
All the insertion points in this text range. | TextRange | ||
kerning : Number
Controls the spacing between two characters (in milli-ems)
| TextRange | ||
length : Number
Length of text range. | TextRange | ||
lines : Lines [read-only]
All the lines in this text range. | TextRange | ||
paragraphAttributes : ParagraphAttributes [read-only]
The paragraph properties for the text range. | TextRange | ||
paragraphs : Paragraphs [read-only]
All the paragraphs in this text range. | TextRange | ||
paragraphStyles : ParagraphStyles [read-only]
List of referenced paragraph styles in the text range. | TextRange | ||
![]() | parent : * [read-only] | IllustratorHostObject | |
story : Story [read-only]
The story of the text range. | TextRange | ||
textRanges : TextRanges [read-only]
All the text in this text range. | TextRange | ||
textSelection : Object [read-only]
The selected text (ranges) in the text range. | TextRange | ||
words : Words [read-only]
All the words in this text range. | TextRange |
Method | Defined By | ||
---|---|---|---|
changeCaseTo(type:CaseChangeType):void
Change the capitalization of text. | TextRange | ||
deSelect():void
Deselect the text range. | TextRange | ||
create a duplicate of the object
| TextRange | ||
![]() | 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 | |
![]() | 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 | |
![]() | 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 | |
![]() | 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 | |
move(relativeObject:Object, insertionLocation:ElementPlacement):void
move the object
| TextRange | ||
remove():void
delete the object
| TextRange | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
select(addToDocument:Boolean = false):void
Select the text range. | TextRange | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
characterAttributes | property |
characterAttributes:CharacterAttributes
[read-only] Since : | CS5 |
The character properties for the text range.
public function get characterAttributes():CharacterAttributes
characterOffset | property |
characterOffset:Number
Since : | CS5 |
Offset of the first character of the range from the beginning of the story, in characters.
public function get characterOffset():Number
public function set characterOffset(value:Number):void
characters | property |
characters:Characters
[read-only] Since : | CS5 |
All the characters in this text range.
public function get characters():Characters
characterStyles | property |
characterStyles:CharacterStyles
[read-only] Since : | CS5 |
List of referenced character styles in the text range.
public function get characterStyles():CharacterStyles
contents | property |
contents:String
Since : | CS5 |
The text string.
public function get contents():String
public function set contents(value:String):void
insertionPoints | property |
insertionPoints:InsertionPoints
[read-only] Since : | CS5 |
All the insertion points in this text range.
public function get insertionPoints():InsertionPoints
kerning | property |
kerning:Number
Since : | CS5 |
Controls the spacing between two characters (in milli-ems)
public function get kerning():Number
public function set kerning(value:Number):void
length | property |
length:Number
Since : | CS5 |
Length of text range. ( minimum 0 )
public function get length():Number
public function set length(value:Number):void
lines | property |
lines:Lines
[read-only] Since : | CS5 |
All the lines in this text range.
public function get lines():Lines
paragraphAttributes | property |
paragraphAttributes:ParagraphAttributes
[read-only] Since : | CS5 |
The paragraph properties for the text range.
public function get paragraphAttributes():ParagraphAttributes
paragraphs | property |
paragraphs:Paragraphs
[read-only] Since : | CS5 |
All the paragraphs in this text range.
public function get paragraphs():Paragraphs
paragraphStyles | property |
paragraphStyles:ParagraphStyles
[read-only] Since : | CS5 |
List of referenced paragraph styles in the text range.
public function get paragraphStyles():ParagraphStyles
story | property |
story:Story
[read-only] Since : | CS5 |
The story of the text range.
public function get story():Story
textRanges | property |
textRanges:TextRanges
[read-only] Since : | CS5 |
All the text in this text range.
public function get textRanges():TextRanges
textSelection | property |
textSelection:Object
[read-only] Since : | CS5 |
The selected text (ranges) in the text range.
public function get textSelection():Object
words | property |
words:Words
[read-only] Since : | CS5 |
All the words in this text range.
public function get words():Words
changeCaseTo | () | method |
public function changeCaseTo(type:CaseChangeType):void
Since : | CS5 |
Change the capitalization of text.
Parameters
type:CaseChangeType — (com.adobe.illustrator.CaseChangeType) The type of case.
|
deSelect | () | method |
public function deSelect():void
Since : | CS5 |
Deselect the text range.
duplicate | () | method |
public function duplicate(relativeObject:Object = null, insertionLocation:ElementPlacement = null):TextRange
Since : | CS5 |
create a duplicate of the object
Parameters
relativeObject:Object (default = null ) — (Object)
| |
insertionLocation:ElementPlacement (default = null ) — (com.adobe.illustrator.ElementPlacement) ( default: ElementPlacement.INSIDE )
|
TextRange |
move | () | method |
public function move(relativeObject:Object, insertionLocation:ElementPlacement):void
Since : | CS5 |
move the object
Parameters
relativeObject:Object — (Object)
| |
insertionLocation:ElementPlacement — (com.adobe.illustrator.ElementPlacement)
|
remove | () | method |
public function remove():void
Since : | CS5 |
delete the object
select | () | method |
public function select(addToDocument:Boolean = false):void
Since : | CS5 |
Select the text range.
Parameters
addToDocument:Boolean (default = false ) — (Boolean) Whether to add the text range to the document text selection. ( default: false )
|