mx.controls.textClasses

# TextRange - AS3 Flex

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.

Related API Elements

mx.controls.Label
mx.controls.RichTextEditor
mx.controls.Text
mx.controls.TextArea
mx.controls.TextInput
flash.text.TextFormatAlign

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
|  | 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 function get endIndex():int`
`public function set endIndex(value:int):void`

### fontFamily

property

`fontFamily:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Name of the font for text in the range. If the range has multiple fonts, this value is `null`.

Implementation
`public function get fontFamily():String`
`public function set fontFamily(value:String):void`

### fontSize

property

`fontSize:int`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Point size of the text in the range. If the range has multiple sizes, this value is 0.

Implementation
`public function get fontSize():int`
`public function set fontSize(value:int):void`

### fontStyle

property

`fontStyle:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Style of the font in the range, as "italic" or "normal". Setting the property to any other string results in normal style. If the range has multiple styles, this value is `null`.

Implementation
`public function get fontStyle():String`
`public function set fontStyle(value:String):void`

### fontWeight

property

`fontWeight:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Weight of the font in the range, as "bold" or "normal". Setting the property to any other string results in normal weight. If the range has multiple weights, this value is `null`.

Implementation
`public function get fontWeight():String`
`public function set fontWeight(value:String):void`

### htmlText

property

`htmlText:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Contents of the range in the form of HTML text. This property returns all HTML markup for the range, including markup for formatting that is applied by Flex, not just HTML that you specify in using an `htmlText` property. This property is, therefore, a full HTML representation of the text as it appears in the control.

Implementation
`public function get htmlText():String`
`public function set htmlText(value:String):void`

### kerning

property

`kerning:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

A Boolean value that indicates whether kerning is enabled (`true`) or disabled (`false`). Kerning adjusts the pixels between certain character pairs to improve readability, and should be used only when necessary, such as with headings in large fonts. Kerning is supported for embedded fonts only. Certain fonts, such as Verdana, and monospaced fonts, such as Courier New, do not support kerning.

The default value is `false.`

Implementation
`public function get kerning():Boolean`
`public function set kerning(value:Boolean):void`

### letterSpacing

property

`letterSpacing:Number`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The number of additional pixels to appear between each character. A positive value increases the character spacing beyond the normal spacing, while a negative value decreases it.

The default value is `0.`

Implementation
`public function get letterSpacing():Number`
`public function set letterSpacing(value:Number):void`

### modifiesSelection

property

`modifiesSelection:Boolean` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Whether the TextRange modifies the currenly selected text. Set by the constructor.

Implementation
`public function get modifiesSelection():Boolean`

### owner

property

`owner:UIComponent`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The control that contains the text. The owner control must have a `textField` property, or, as is the case of the RichTextEditor control, a `textArea` property. The owner of the text in a RichTextEditor control is the RichTextEditor control, not its TextArea subcontrol. Initially set by the constructor.

Implementation
`public function get owner():UIComponent`
`public function set owner(value:UIComponent):void`

### text

property

`text:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Plain-text contents of the range.

Implementation
`public function get text():String`
`public function set text(value:String):void`

### textAlign

property

`textAlign:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Alignment of the text in the range. The flash.text.TextFormatAlign constants specify the valid values. Setting this property to any other value has no effect. If the range has multiple alignments, this value is `null`.

Implementation
`public function get textAlign():String`
`public function set textAlign(value:String):void`

Related API Elements

flash.text.TextFormatAlign

### textDecoration

property

`textDecoration:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Decoration of the font in the range, as "underline" or "normal". Setting the property to any other string results in normal text. If the range has multiple decoration settings, this value is `null`.

Implementation
`public function get textDecoration():String`
`public function set textDecoration(value:String):void`

### url

property

`url:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

URL for a hypertext link in the range. If the range does not include a link, the value is the empty string. If the range includes multiple links, the value is `null`.

Implementation
`public function get url():String`
`public function set url(value:String):void`
Constructor Detail

### TextRange

()
Constructor

`public function TextRange(owner:UIComponent, modifiesSelection:Boolean = false, beginIndex:int = -1, endIndex:int = -1)`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Create a new TextRange Object that represents a subset of the contents of a text control, including the formatting information.

Parameters

| `owner:UIComponent` — The control that contains the text. The control must have a `textField` property, or, as is the case of the RichTextEditor control, a `textArea` property.
| `modifiesSelection:Boolean` (default = `false`)`` — Whether to select the text in the range. If you set this parameter to `true` and do not specify a begin or end index that corresponds to text in the control, Flex uses the begin or end index of the current text selection. If this parameter is `true`, you omit the `beginIndex` and `endIndex` parameters, and there is no selection, the TextRange object is empty.
| `beginIndex:int` (default = `-1`)`` — Zero-based index of the first character in the range. If the `modifiesSelection` parameter is `false` and you omit this parameter or specify a negative value, the range starts with the first text character.
| `endIndex:int` (default = `-1`)`` — Zero-based index of the position after the last character in the range. If the `modifiesSelection` parameter is `false` and you omit this parameter, specify a negative value, or specify a value past the end of the text, the range ends with the last text character.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00