Text.replaceWholeText()

Deprecated

This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

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

Browser compatibility

BCD tables only load in the browser

See also

  • The Text interface it belongs to.