Text.replaceWholeText()

Obsolete
This feature is obsolete. Although it may still work in some browsers, its use is discouraged since it could be removed at any time. Try to avoid using it.

The Text.replaceWholeText() method replaces the text of the node and all of its logically adjacent text nodes with the specified text. The replaced nodes are removed, including the current node, unless it was the recipient of the replacement text.

A DOMException with the value NO_MODIFICATION_ERR is thrown if one of the text nodes being replaced is read only.

This method returns the text node which received the replacement text, or null if the replacement text is an empty string.  The returned node is the current node unless the current node is read only, in which case the returned node is a newly created text node of the same type which has been inserted at the location of the replacement.

Syntax

replacementNode = textnode.replaceWholeText(content) 

Example

See the example for the Text.wholeText property.

Specifications

Specification Status Comment
DOM
The definition of 'Text' in that specification.
Living Standard Removed from the specification.
Document Object Model (DOM) Level 3 Core Specification
The definition of 'Text' in that specification.
Recommendation Initial definition.

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari
Basic support (Yes) [1]
30.0
Not supported 41.0
3.5 (1.9.1) [3]
Removed in 10 (10)
(Yes) (Yes) [2]
17.0
(Yes) [4]
Feature Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support (Yes) 1.0 (1.9.1) [3]
Removed in 10.0 (10)
(Yes) (Yes) [2]
17.0
(Yes)[4]

[1] Before Chrome 30, the argument wasn't mandatory, like required by the specs.

[2] Before Opera 17, the argument wasn't mandatory, like required by the specs.

[3] Firefox's implementation of this method never supported EntityReference nodes as defined by the specification.

[4] The argument is not mandatory, though required by the spec.

See also

  • The Text interface it belongs to.

Document Tags and Contributors

 Contributors to this page: jwhitlock, teoli, ziyunfei, jsx, Reachmeatshivam, Sheppy
 Last updated by: jwhitlock,