Document.CreateTreeWalker
Contents
[
Hide
]CreateTreeWalker(Node)
Create a new TreeWalker over the subtree rooted at the specified node.
public ITreeWalker CreateTreeWalker(Node root)
Parameter | Type | Description |
---|---|---|
root | Node | node which will serve as the root for the TreeWalker. The whatToShow flags and the NodeFilter are not considered when setting this value; any node type will be accepted as the root. The currentNode of the TreeWalker is initialized to this node, whether or not it is visible. The root functions as a stopping point for traversal methods that look upward in the document structure, such as parentNode and nextNode. The root must not be null. |
Return Value
The newly created TreeWalker.
Exceptions
exception | condition |
---|---|
DOMException | NOT_SUPPORTED_ERR: Raised if the specified root is null. |
See Also
- interface ITreeWalker
- class Node
- class Document
- namespace Aspose.Html.Dom
- assembly Aspose.HTML
CreateTreeWalker(Node, long)
Create a new TreeWalker over the subtree rooted at the specified node.
public ITreeWalker CreateTreeWalker(Node root, long whatToShow)
Parameter | Type | Description |
---|---|---|
root | Node | node which will serve as the root for the TreeWalker. The whatToShow flags and the NodeFilter are not considered when setting this value; any node type will be accepted as the root. The currentNode of the TreeWalker is initialized to this node, whether or not it is visible. The root functions as a stopping point for traversal methods that look upward in the document structure, such as parentNode and nextNode. The root must not be null. |
whatToShow | Int64 | flag specifies which node types may appear in the logical view of the tree presented by the tree-walker. See the description of NodeFilter for the set of possible SHOW_ values.These flags can be combined using OR. |
Return Value
The newly created TreeWalker.
Exceptions
exception | condition |
---|---|
DOMException | NOT_SUPPORTED_ERR: Raised if the specified root is null. |
See Also
- interface ITreeWalker
- class Node
- class Document
- namespace Aspose.Html.Dom
- assembly Aspose.HTML
CreateTreeWalker(Node, long, INodeFilter)
Create a new TreeWalker over the subtree rooted at the specified node.
public ITreeWalker CreateTreeWalker(Node root, long whatToShow, INodeFilter filter)
Parameter | Type | Description |
---|---|---|
root | Node | node which will serve as the root for the TreeWalker. The whatToShow flags and the NodeFilter are not considered when setting this value; any node type will be accepted as the root. The currentNode of the TreeWalker is initialized to this node, whether or not it is visible. The root functions as a stopping point for traversal methods that look upward in the document structure, such as parentNode and nextNode. The root must not be null. |
whatToShow | Int64 | flag specifies which node types may appear in the logical view of the tree presented by the tree-walker. See the description of NodeFilter for the set of possible SHOW_ values.These flags can be combined using OR. |
filter | INodeFilter | NodeFilter to be used with this TreeWalker, or null to indicate no filter. |
Return Value
The newly created TreeWalker.
Exceptions
exception | condition |
---|---|
DOMException | NOT_SUPPORTED_ERR: Raised if the specified root is null. |
See Also
- interface ITreeWalker
- class Node
- interface INodeFilter
- class Document
- namespace Aspose.Html.Dom
- assembly Aspose.HTML