mx.controls.textClasses.TextRange - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.controls.textClasses
Class	public class TextRange
Inheritance	TextRange Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The TextRange class provides properties that select and format a range of text in the Label, Text, TextArea, TextEditor, and RichTextEditor controls.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		beginIndex : int Zero-based index in the control's text field of the first character in the range.	TextRange
		bullet : Boolean Whether the text in the range is in a bulleted list.	TextRange
		color : Object Color of the text in the range.	TextRange
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		endIndex : int Zero-based index in the control's text field of the point immediately after the last character in the range; equivalent to the One-based index of the last character.	TextRange
		fontFamily : String Name of the font for text in the range.	TextRange
		fontSize : int Point size of the text in the range.	TextRange
		fontStyle : String Style of the font in the range, as "italic" or "normal".	TextRange
		fontWeight : String Weight of the font in the range, as "bold" or "normal".	TextRange
		htmlText : String Contents of the range in the form of HTML text.	TextRange
		kerning : Boolean A Boolean value that indicates whether kerning is enabled (true) or disabled (false).	TextRange
		letterSpacing : Number The number of additional pixels to appear between each character.	TextRange
		modifiesSelection : Boolean [read-only] Whether the TextRange modifies the currenly selected text.	TextRange
		owner : UIComponent The control that contains the text.	TextRange
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		text : String Plain-text contents of the range.	TextRange
		textAlign : String Alignment of the text in the range.	TextRange
		textDecoration : String Decoration of the font in the range, as "underline" or "normal".	TextRange
		url : String URL for a hypertext link in the range.	TextRange

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		TextRange(owner:UIComponent, modifiesSelection:Boolean = false, beginIndex:int = -1, endIndex:int = -1) Create a new TextRange Object that represents a subset of the contents of a text control, including the formatting information.	TextRange
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

Property Detail

beginIndex

property

beginIndex:int

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Zero-based index in the control's text field of the first character in the range. If the fifth character in the text is the first character in the range, this property has a value of 4.

Implementation
public function get beginIndex():int
public function set beginIndex(value:int):void

bullet

property

bullet:Boolean

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Whether the text in the range is in a bulleted list. If only part of the range is in a bulleted list, this value is false.

Implementation
public function get bullet():Boolean
public function set bullet(value:Boolean):void

color

property

color:Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Color of the text in the range. You can set this value using any valid color identifier. The property returns the value as a numeric value. If the range has multiple colors, this value is null.

Implementation
public function get color():Object
public function set color(value:Object):void

endIndex

property

endIndex:int

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Zero-based index in the control's text field of the point immediately after the last character in the range; equivalent to the One-based index of the last character. If the fifth character in the text is the last character in the range, this property has a value of 5.

Implementation
public f