flashx.textLayout.elements

# TextRange - AS3

Package | flashx.textLayout.elements
Class | public class TextRange
Inheritance | TextRange Object
Subclasses | SelectionState

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

A read only class that describes a range of contiguous text. Such a range occurs when you select a section of text. The range consists of the anchor point of the selection, `anchorPosition`, and the point that is to be modified by actions, `activePosition`. As block selections are modified and extended `anchorPosition` remains fixed and `activePosition` is modified. The anchor position may be placed in the text before or after the active position.

Related API Elements

TextFlow
SelectionState

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | absoluteEnd : int End of the selection, as an absolute position in the TextFlow. | TextRange
|  | absoluteStart : int Start of the selection, as an absolute position in the TextFlow. | TextRange
|  | activePosition : int Active position of the selection, as an absolute position in the TextFlow. | TextRange
|  | anchorPosition : int Anchor position of the selection, as an absolute position in the TextFlow. | TextRange
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | textFlow : flashx.textLayout.elements:TextFlow Returns the TextFlow associated with the selection. | TextRange

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | TextRange(root:flashx.textLayout.elements:TextFlow, anchorIndex:int, activeIndex:int) Constructor - creates a new TextRange instance. | 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
|  | updateRange(newAnchorPosition:int, newActivePosition:int):Boolean Update the range with new anchor or active position values. | TextRange
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Property Detail

### absoluteEnd

property

`absoluteEnd:int`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

End of the selection, as an absolute position in the TextFlow.

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

### absoluteStart

property

`absoluteStart:int`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Start of the selection, as an absolute position in the TextFlow.

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

### activePosition

property

`activePosition:int`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Active position of the selection, as an absolute position in the TextFlow.

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

### anchorPosition

property

`anchorPosition:int`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Anchor position of the selection, as an absolute position in the TextFlow.

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

### textFlow

property

`textFlow:flashx.textLayout.elements:TextFlow`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Returns the TextFlow associated with the selection.

Implementation
`public function get textFlow():flashx.textLayout.elements:TextFlow`
`public function set textFlow(value:flashx.textLayout.elements:TextFlow):void`
Constructor Detail

### TextRange

()
Constructor

`public function TextRange(root:flashx.textLayout.elements:TextFlow, anchorIndex:int, activeIndex:int)`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Constructor - creates a new TextRange instance. A TextRange can be (-1,-1), indicating no range, or a pair of values from 0 to `TextFlow.textLength`.

Parameters

| `root:flashx.textLayout.elements:TextFlow` — the TextFlow associated with the selection.
| `anchorIndex:int` — the index position of the anchor in the selection. The first position in the text is position 0.
| `activeIndex:int` — the index position of the active location in the selection. The first position in the text is position 0.

Related API Elements

FlowElement.textLength
Method Detail

### updateRange

()
method

`public function updateRange(newAnchorPosition:int, newActivePosition:int):Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Update the range with new anchor or active position values.

Parameters

| `newAnchorPosition:int` — the anchor index of the selection.
| `newActivePosition:int` — the active index of the selection.

Returns

| `Boolean` — true if selection is changed.

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