Node class
Node class
The Node interface is the primary datatype for the entire Document object Model. It represents a single node in the document tree.
Inheritance: Node
→
EventTarget
→
DOMObject
The Node type exposes the following members:
Properties
Property | Description |
---|---|
node_type | A code representing the type of the underlying object. |
local_name | Returns the local part of the qualified name of this node. For nodes of any type other than Node.ELEMENT_NODE and Node.ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as Document.create_element , this is always null. |
namespace_uri | Returns the namespace URI of the element, or null if the element is not in a namespace. |
prefix | Returns the namespace prefix of the specified element, or null if no prefix is specified. |
node_name | Returns the name of the current node as a string. |
base_uri | Returns the absolute base URL of the document containing the node. The base URL is used to resolve relative URLs when the browser needs to obtain an absolute URL, for example when processing the HTML img element’s src attribute or the xlink:href or href attributes in SVG. |
owner_document | Returns the top-level document object of the node. |
parent_node | Returns the parent of the specified node in the DOM tree.Document and DocumentFragment nodes can never have a parent, so will always return null. It also returns if the node has just been created and is not yet attached to the tree. |
parent_element | Returns the DOM node’s parent Element , or if the node either has no parent, or its parent isn’t a DOM Element. |
child_nodes | Returns a live NodeList of child nodes of the given element where the first child node is assigned index 0. Child nodes include elements, text and comments. |
first_child | Returns the node’s first child in the tree, or null if the node has no children. If the node is a Document, this property returns the first node in the list of its direct children. |
last_child | Returns the last child of the node. If its parent is an element, then the child is generally an element node, a text node, or a comment node. It returns null if there are no child elements |
previous_sibling | Returns the node immediately preceding the specified one in its parent’s Node.child_nodes list, or if the specified node is the first in that list. |
next_sibling | Returns the node immediately following the specified one in their parent’s Node.child_nodes , or returns null if the specified node is the last child in the parent element. |
node_value | Returns or sets the value of the current node. |
text_content | Represents the text content of the node and its descendants. |
ELEMENT_NODE | An element node |
ATTRIBUTE_NODE | An attribute node |
TEXT_NODE | A text node |
CDATA_SECTION_NODE | A cdata section node |
ENTITY_REFERENCE_NODE | An entity reference node |
ENTITY_NODE | An entity node |
PROCESSING_INSTRUCTION_NODE | A processing instruction node |
COMMENT_NODE | A comment node |
DOCUMENT_NODE | A document node |
DOCUMENT_TYPE_NODE | A document type node |
DOCUMENT_FRAGMENT_NODE | A document fragment node |
NOTATION_NODE | A notation node |
Methods
Method | Description |
---|---|
add_event_listener | Sets up a function that will be called whenever the specified event is delivered to the target. It works by adding a function, or an object that implements IEventListener ,to the list of event listeners for the specified event type on the EventTarget on which it’s called.If the function or object, is already in the list of event listeners for this target, they are not added a second time. |
add_event_listener | Sets up a function that will be called whenever the specified event is delivered to the target. It works by adding a function, or an object that implements IEventListener ,to the list of event listeners for the specified event type on the EventTarget on which it’s called.If the function or object, is already in the list of event listeners for this target, they are not added a second time. |
remove_event_listener | This 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_listener | This 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_node | Returns a duplicate of the node on which this method was called. Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners. It does not copy event listeners added using IEventTarget.add_event_listener or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied. |
clone_node | Returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in a node is also cloned or not. Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners. It does not copy event listeners added using IEventTarget.add_event_listener or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied. |
get_platform_type | This method is used to retrieve the ECMAScript object Type. |
dispatch_event | Dispatches an Event at the specified IEventTarget , (synchronously) invokingthe affected EventListeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with IEventTarget.dispatch_event . |
has_child_nodes | Returns a boolean value indicating whether the given Node has child nodes or not. |
normalize | Puts 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_node | Tests 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_node | Method is a legacy alias the for the strict equality operator. That is, it tests whether two nodes are the same (in other words, whether they reference the same object). |
lookup_prefix | Look 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_uri | Look up the namespace URI associated to the given prefix, starting from this node. |
is_default_namespace | This method checks if the specified namespaceURI is the default namespace or not. |
insert_before | Inserts 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_child | Replaces 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_child | Removes a child node from the DOM and returns the removed node. |
append_child | Adds a node to the end of the list of children of a specified parent node. If the given child is a reference to an existing node in the document, Node.append_child moves it from its current position to the new position (there is no requirement to remove the node from its parent node before appending it to some other node).This means that a node can’t be in two points of the document simultaneously. So if the node already has a parent, the node is first removed, then appended at the new position. The Node.clone_node method can be used to make a copy of the node before appending it under the new parent. Copies made with Node.clone_node are not be automatically kept in sync. |
See Also
- module
aspose.html.dom
- class
DOMObject
- class
Document
- class
DocumentFragment
- class
Element
- class
EventTarget
- class
IEventListener
- class
IEventTarget
- class
Node
- class
NodeList