| INodeIterator Interface |
Iterators are used to step through a set of nodes, e.g. the
set of nodes in a NodeList, the document subtree governed by
a particular Node, the results of a query, or any other set
of nodes. The set of nodes to be iterated is determined by the
implementation of the NodeIterator. DOM Level 2 specifies a
single NodeIterator implementation for document-order
traversal of a document subtree. Instances of these iterators are created
by calling DocumentTraversal
.createNodeIterator().
See also the Document object Model (DOM) Level 2 Traversal and Range Specification. @since DOM Level 2
Namespace: Aspose.Html.Dom.Traversal
Assembly: Aspose.HTML (in Aspose.HTML.dll) Version: 20.3
SyntaxThe INodeIterator type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Filter |
The NodeFilter used to screen nodes.
(Inherited from ITraversal.) |
| PointerBeforeReferenceNode |
The value of this flag determines whether the children of entity
reference nodes are visible to the iterator. If false, they and
their descendants will be rejected. Note that this rejection takes
precedence over whatToShow and the filter. Also note
that this is currently the only situation where
NodeIterators may reject a complete subtree rather than
skipping individual nodes.
To produce a view of the document that has entity references
expanded and does not expose the entity reference node itself, use
the whatToShow flags to hide the entity reference node
and set expandEntityReferences to true when creating the
iterator. To produce a view of the document that has entity reference
nodes but no entity expansion, use the whatToShow flags
to show the entity reference node and set
expandEntityReferences to false.
|
| ReferenceNode |
The current reference node.
|
| Root |
The root node of the NodeIterator, as specified when it
was created.
(Inherited from ITraversal.) |
| WhatToShow |
This attribute determines which node types are presented via the
iterator. The available set of constants is defined in the
NodeFilter interface. Nodes not accepted by
whatToShow will be skipped, but their children may still
be considered. Note that this skip takes precedence over the filter,
if any.
(Inherited from ITraversal.) |
Methods| Name | Description | |
|---|---|---|
 | Detach |
Detaches the NodeIterator from the set which it iterated
over, releasing any computational resources and placing the iterator
in the INVALID state. After detach has been invoked,
calls to nextNode or previousNode will
raise the exception INVALID_STATE_ERR.
|
| Dispose | (Inherited from IDisposable.) |
| NextNode |
Returns the next node in the set and advances the position of the
iterator in the set. After a NodeIterator is created,
the first call to nextNode() returns the first node in
the set.
|
| PreviousNode |
Returns the previous node in the set and moves the position of the
NodeIterator backwards in the set.
|
See Also