XPathNavigator.IsDescendant(XPathNavigator) Method

Definition

Determines whether the specified XPathNavigator is a descendant of the current XPathNavigator.

public:
 virtual bool IsDescendant(System::Xml::XPath::XPathNavigator ^ nav);
public virtual bool IsDescendant (System.Xml.XPath.XPathNavigator nav);
abstract member IsDescendant : System.Xml.XPath.XPathNavigator -> bool
override this.IsDescendant : System.Xml.XPath.XPathNavigator -> bool
Public Overridable Function IsDescendant (nav As XPathNavigator) As Boolean

Parameters

nav
XPathNavigator

The XPathNavigator to compare to this XPathNavigator.

Returns

true if the specified XPathNavigator is a descendant of the current XPathNavigator; otherwise, false.

Remarks

An XPathNavigator is a descendant of the current XPathNavigator if it is positioned on a descendant node of the current XPathNavigator. Take, for example, the following XML string:

<item><name>widget</name></item>

If the current XPathNavigator is positioned on the item node, and the XPathNavigator specified is positioned on the name node, IsDescendant returns true.

This method always returns false under the following conditions:

  • The XPathNavigator specified shares the same implementation but points at a different document instance than the current navigator.

  • The XPathNavigator specified has a different implementation than the current navigator.

Applies to