Skip to main content

DOMDocument.CreateNodeIterator

CreateNodeIterator

Syntax

CreateNodeIterator(<Node>, <Filter>, <OverrideEntityReferences>)

Parameters

<Node> (required)

Type: DOMAttribute, DOMDocument, DOMElement, DOMDocumentType, DOMNotation, DOMEntity, DOMDocumentFragment, DOMText, DOMComment, DOMCDATASection, DOMProcessingInstruction, DOMEntityReference, XPathNamespace. DOM node is starting node of the iterator.

<Filter> (optional)

Type: DOMNodeFilter. DOM node filter. If not specified, all nodes will be iterated.

<OverrideEntityReferences> (optional)

Type: Boolean. Flag for overriding DOM entities references. True - during entity reference node override, entity content node override will take place, otherwise the override will not take place. Default value: True.

Returned value

Type: DOMNodeIterator.

Description

It creates a new iterator for DOM document sub-tree, starting from specified node. When created, the iterator is set to a position before the specified node. The method corresponds to the NodeIterator interface of W3C standard (for details see http://www.w3.org/TR/2000/REC-DOM-Level-2-Traversal-Range-20001113/traversal.html#Traversal-NodeIterator).

Availability

Server, thick client, external connection, mobile application (server), mobile standalone server.

Translation

Русская версия: ДокументDOM.СоздатьИтераторУзлов (DOMDocument.CreateNodeIterator)