This page is Ready to Use

Notice: The WebPlatform project, supported by various stewards between 2012 and 2015, has been discontinued. This site is now available on github.

TextRange

Summary

Represents text in an HTML element.

Properties

boundingHeight
Retrieves the height of the rectangle that bounds the TextRange object.
boundingLeft
Retrieves the distance between the left edge of the rectangle that bounds the TextRange object and the left side of the object that contains the TextRange.
boundingTop
Retrieves the distance between the top edge of the rectangle that bounds the TextRange object and the top side of the object that contains the TextRange.
boundingWidth
Retrieves the width of the rectangle that bounds the TextRange object
text
Sets or retrieves the text contained within the range.

Methods

duplicate
Returns a duplicate of the TextRange.
getBookmark
Retrieves a bookmark (opaque string) that can be used with moveToBookmark to return to the same range.

item
:

move
Collapses the given text range and moves the empty range by the given number of units.
moveEnd
Changes the end position of the range.
moveStart
Changes the start position of the range.
moveToBookmark
Moves to a bookmark.
moveToElementText
Moves the text range so that the start and end positions of the range encompass the text in the given element.
moveToPoint
Moves the start and end positions of the text range to the given point.
parentElement
Retrieves the parent element for the given text range.
pasteHTML
Pastes HTML text into the given text range, replacing any previous text and HTML elements in the range.
queryCommandEnabled
Returns a Boolean value that indicates whether a specified command can be successfully executed using execCommand, given the current state of the document.
queryCommandIndeterm
Returns a Boolean value that indicates whether the specified command is in the indeterminate state.
queryCommandState
Returns a Boolean value that indicates the current state of the command.
queryCommandSupported
Returns a Boolean value that indicates whether the current command is supported on the current range.
queryCommandValue
Returns the current value of the document, range, or current selection for the given command.
scrollIntoView
Causes the object to scroll into view, aligning it either at the top or bottom of the window.
select
Makes the selection equal to the current object.
setEndPoint
Sets the endpoint of one range based on the endpoint of another range.

Events

No events.

Examples

This example changes the text of a button element to “Clicked” through the TextRange object.

<script type="text/javascript">
var b = document.all.tags("button");
if (b!=null) {
    var r = b[0].createTextRange();
    if (r != null) {
        r.text = "Clicked";
    }
}
</script>

Usage

 Use this object to retrieve and modify text in an element, to locate specific strings in the text, and to carry out commands that affect the appearance of the text.

Notes

Remarks

To retrieve a text range object, apply the createRange method to a body, button, or textArea element or an input element that has TYPE text. Modify the extent of the text range by moving its start and end positions with methods such as move and moveToElementText. Within the text range, you can retrieve and modify plain text or HTML text. These forms of text are identical except that HTML text includes HTML tags, and plain text does not.

Attributions