TextRange object

Represents text in an HTML element.

Members

The TextRange object has these types of members:

Methods

The TextRange object has these methods.

MethodDescription
compareEndPoints

Compares an end point of a TextRange object with an end point of another range.

duplicate

Returns a duplicate of the TextRange.

execCommandShowHelp

Displays help information for the given command identifier.

expand

Expands the range so that partial units are completely contained.

findText

Searches for text in the document and positions the start and end points of the range to encompass the search string.

getBookmark

Retrieves a bookmark (opaque string) that can be used with moveToBookmark to return to the same range.

getBoundingClientRect

Retrieves an object that specifies the bounds of a collection of TextRectangle objects.

getClientRects

Retrieves a collection of rectangles that describes the layout of the contents of an object or range within the client. Each rectangle describes a single line.

inRange

Returns a value indicating whether one range is contained within another.

isEqual

Returns a value indicating whether the specified range is equal to the current range.

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.

queryCommandText

Retrieves the string associated with a command.

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.

 

Properties

The TextRange object has these properties.

PropertyDescription

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.

htmlText

Retrieves the HTML source as a valid HTML fragment.

offsetLeft

Retrieves the calculated left position of the object relative to the layout or coordinate parent, as specified by the offsetParent property.

offsetTop

Retrieves the calculated top position of the object relative to the layout or coordinate parent, as specified by the offsetParent property.

text

Sets or retrieves the text contained within the range.

 

Standards information

There are no standards that apply here.

Remarks

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.

To retrieve a text range object, apply the createTextRange 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, moveToElementText, and findText. 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.

Examples

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


<!DOCTYPE html>

<html>
<head>
  <title>createTextRange</title>
</head>
<body>
  <button>Button</button>
  <script>
    var b = document.all.tags("button");
    console.log(b[0]);

    if (b != null) {
      var r = b[0].createTextRange();
      if (r != null) {
        r.text = "Clicked";
      }
    }
  </script>
</body>
</html>

See also

createTextRange

 

 

Show:
© 2014 Microsoft