Text class

Text class

The Text interface inherits from CharacterData and represents the textual content (termed character data in XML) of an Element or Attr.

Inheritance: TextCharacterDataNodeEventTargetDOMObject

The Text type exposes the following members:

Properties

PropertyDescription
node_typeA code representing the type of the underlying object.
local_nameReturns the local part of the qualified name of this node.
For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as Document.createElement(), this is always null.
namespace_uriThe namespace URI of this node, or null if it is unspecified.
prefixThe namespace prefix of this node, or null if it is unspecified. When it is defined to be null, setting it has no effect
node_nameThe name of this node, depending on its type.
base_uriThe absolute base URI of this node or null if the implementation wasn’t able to obtain an absolute URI.
owner_documentThe Document object associated with this node. This is also the Document object used to create new nodes. When this node is a Document or a DocumentType which is not used with any Document yet, this is null.
parent_nodeThe parent of this node. All nodes, except Attr, Document, DocumentFragment, Entity, and Notation may have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, this is null.
parent_elementGets the parent Element of this node.
child_nodesA NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes..
first_childThe first child of this node. If there is no such node, this returns null.
last_childThe last child of this node. If there is no such node, this returns null.
previous_siblingThe node immediately preceding this node. If there is no such node, this returns null.
next_siblingThe node immediately following this node. If there is no such node, this returns null.
node_valueThe value of this node, depending on its type.
text_contentThis attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new string is not empty or null, replaced by a single Text node containing the string this attribute is set to.
ELEMENT_NODEAn element node
ATTRIBUTE_NODEAn attribute node
TEXT_NODEA text node
CDATA_SECTION_NODEA cdata section node
ENTITY_REFERENCE_NODEAn entity reference node
ENTITY_NODEAn entity node
PROCESSING_INSTRUCTION_NODEA processing instruction node
COMMENT_NODEA comment node
DOCUMENT_NODEA document node
DOCUMENT_TYPE_NODEA document type node
DOCUMENT_FRAGMENT_NODEA document fragment node
NOTATION_NODEA notation node
dataThe character data of the node that implements this interface.
lengthThe number of 16-bit units that are available through data and the substringData method below. This may have the value zero, i.e., CharacterData nodes may be empty.
is_element_content_whitespaceReturns whether this text node contains element content whitespace, often abusively called “ignorable whitespace”.
whole_textReturns all text of Text nodes logically-adjacent text nodes to this node, concatenated in document order.

Methods

MethodDescription
add_event_listenerThis method allows the registration of event listeners on the event target.
add_event_listenerThis method allows the registration of event listeners on the event target.
remove_event_listenerThis method allows the removal of event listeners from the event target.
If an IEventListener is removed from an EventTarget while it is processing an event, it will not be triggered by the current actions.
Event Listeners can never be invoked after being removed.
remove_event_listenerThis method allows the removal of event listeners from the event target.
If an IEventListener is removed from an EventTarget while it is processing an event, it will not be triggered by the current actions.
Event Listeners can never be invoked after being removed.
clone_nodeReturns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent (parentNode is null) and no user data.
clone_nodeReturns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent (parentNode is null) and no user data.
get_platform_typeThis method is used to retrieve ECMAScript object Type.
dispatch_eventThis method allows the dispatch of events into the implementations event model.
has_child_nodesReturns whether this node has any children.
normalizePuts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a “normal” form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are neither adjacent Text nodes nor empty Text nodes. This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer [XPointer] lookups) that depend on a particular document tree structure are to be used. If the parameter “normalize-characters” of the DOMConfiguration object attached to the Node.ownerDocument is true, this method will also fully normalize the characters of the Text nodes.
is_equal_nodeTests whether two nodes are equal.
This method tests for equality of nodes, not sameness (i.e., whether the two nodes are references to the same object) which can be tested with Node.isSameNode(). All nodes that are the same will also be equal, though the reverse may not be true.
is_same_nodeReturns whether this node is the same node as the given one.
This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.
lookup_prefixLook up the prefix associated to the given namespace URI, starting from this node. The default namespace declarations are ignored by this method.
See Namespace Prefix Lookup for details on the algorithm used by this method.
lookup_namespace_uriLook up the namespace URI associated to the given prefix, starting from this node.
is_default_namespaceThis method checks if the specified namespaceURI is the default namespace or not.
insert_beforeInserts the node before the existing child node child. If child is null, insert node at the end of the list of children.
If child is a DocumentFragment object, all of its children are inserted, in the same order, before child. If the child is already in the tree, it is first removed.
replace_childReplaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
If newChild is a DocumentFragment object, oldChild is replaced by all of the DocumentFragment children, which are inserted in the same order. If the newChild is already in the tree, it is first removed.
remove_childRemoves the child node indicated by oldChild from the list of children, and returns it.
append_childAdds the node newChild to the end of the list of children of this node. If the newChild is already in the tree, it is first removed.
substring_dataExtracts a range of data from the node.
append_dataAppend the string to the end of the character data of the node.
insert_dataInsert a string at the specified 16-bit unit offset.
delete_dataRemove a range of 16-bit units from the node.
replace_dataReplace the characters starting at the specified 16-bit unit offset with the specified string.
split_textBreaks this node into two nodes at the specified offset, keeping both in the tree as siblings.
replace_whole_textReplaces the text of the current node and all logically-adjacent text nodes with the specified text. All logically-adjacent text nodes are removed including the current node unless it was the recipient of the replacement text.

See Also