All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

XMLParser Interface CATIDOMDocumentTraversal

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIDOMDocumentTraversal
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIDOMDocumentTraversal

Interface which contains methods that create iterators and tree-walkers to traverse a node and its children in document order (depth first, pre-order traversal, which is equivalent to the order in which the start tags occur in the text representation of the document).
In DOMs which support the Traversal feature, CATIDOMDocumentTraversal will be implemented by the same objects that implement the CATIDOMDocument interface.

See also the Document Object Model (DOM) Level 2 Traversal and Range Specification.


Method Index


o CreateNodeIterator(CATIDOMNode_var&,unsigned int,CATIDOMNodeFilter_var&,CATBoolean,CATIDOMNodeIterator_var&)
Creates a new CATIDOMNodeIterator over the subtree rooted at the specified node.
o CreateTreeWalker(CATIDOMNode_var&,unsigned int,CATIDOMNodeFilter_var&,CATBoolean,CATIDOMTreeWalker_var&)
Creates a new CATIDOMTreeWalker over the subtree rooted at the specified node.

Methods


o CreateNodeIterator
public virtual HRESULT CreateNodeIterator( const CATIDOMNode_var& iRoot,
const unsigned int iWhatToShow,
const CATIDOMNodeFilter_var& iFilter,
const CATBoolean iEntityReferenceExpansion,
CATIDOMNodeIterator_var& oNodeIterator) = 0
Creates a new CATIDOMNodeIterator over the subtree rooted at the specified node.
Parameters:
iRoot
The node which will be iterated together with its children. The iterator is initially positioned just before this node. The iWhatToShow flags and the filter, if any, are not considered when setting this position. The root must not be NULL_var.
iWhatToShow
This flag specifies which node types may appear in the logical view of the tree presented by the iterator. See the description of
CATIDOMNodeFilter for the set of possible SHOW_ values.These flags can be combined using OR.
iFilter
The
CATIDOMNodeFilter to be used with this CATIDOMTreeWalker, or NULL_var to indicate no filter.
iEntityReferenceExpansion
The value of this flag determines whether entity reference nodes are expanded.
oNodeIterator
The newly created
CATIDOMNodeIterator.
Errors Returned:
Error Class Error Id Description
CATDOMException XMLParserERR_2209 NOT_SUPPORTED_ERR: Raised if the specified root is NULL_var.
o CreateTreeWalker
public virtual HRESULT CreateTreeWalker( const CATIDOMNode_var& iRoot,
const unsigned int iWhatToShow,
const CATIDOMNodeFilter_var& iFilter,
const CATBoolean iEntityReferenceExpansion,
CATIDOMTreeWalker_var& oTreeWalker)= 0
Creates a new CATIDOMTreeWalker over the subtree rooted at the specified node.
Parameters:
iRoot
The node which will serve as the root for the
CATIDOMTreeWalker. The iWhatToShow flags and the CATIDOMNodeFilter are not considered when setting this value; any node type will be accepted as the root. The currentNode of the CATIDOMTreeWalker 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 CATIDOMTreeWalker.ParentNode and CATIDOMTreeWalker.NextNode. The root must not be NULL_var.
iWhatToShow
This flag specifies which node types may appear in the logical view of the tree presented by the tree-walker. See the description of
CATIDOMNodeFilter for the set of possible SHOW_ values.These flags can be combined using OR.
iFilter
The
CATIDOMNodeFilter to be used with this CATIDOMTreeWalker, or NULL_var to indicate no filter.
iEntityReferenceExpansion
If this flag is false, the contents of
CATIDOMEntityReference nodes are not presented in the logical view.
oTreeWalker
The newly created
CATIDOMTreeWalker.
Errors Returned:
Error Class Error Id Description
CATDOMException XMLParserERR_2209 NOT_SUPPORTED_ERR: Raised if the specified root is NULL_var.

This object is included in the file: CATIDOMDocumentTraversal.h
If needed, your Imakefile.mk should include the module: CATXMLParserItf

Copyright © 2003, Dassault Systèmes. All rights reserved.