XPathResult

The XPathResult interface represents the results generated by evaluating an XPath expression within the context of a given node. Since XPath expressions can result in a variety of result types, this interface makes it possible to determine and handle the type and value of the result.

Properties

XPathResult.booleanValueRead only

A boolean representing the value of the result if resultType is BOOLEAN_TYPE.

XPathResult.invalidIteratorStateRead only

Signifies that the iterator has become invalid. It is true if resultType is UNORDERED_NODE_ITERATOR_TYPE or ORDERED_NODE_ITERATOR_TYPE and the document has been modified since this result was returned.

XPathResult.numberValueRead only

A number representing the value of the result if resultType is NUMBER_TYPE.

XPathResult.resultTypeRead only

A number code representing the type of the result, as defined by the type constants.

XPathResult.singleNodeValueRead only

A Node representing the value of the single node result, which may be null.

XPathResult.snapshotLengthRead only

The number of nodes in the result snapshot.

XPathResult.stringValueRead only

A string representing the value of the result if resultType is STRING_TYPE.

Methods

XPathResult.iterateNext()

If the result is a node set, this method iterates over it and returns the next node from it or null if there are no more nodes.

XPathResult.snapshotItem()

Returns an item of the snapshot collection or null in case the index is not within the range of nodes. Unlike the iterator result, the snapshot does not become invalid, but may not correspond to the current document if it is mutated.

Constants

Specifications

Browser compatibility

See also

• Document.evaluate()
• XPathExpression
• Dottoro Web Reference - XPathResult object