XPathNavigator.IsDescendant Method (XPathNavigator)

 

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

Namespace:   System.Xml.XPath
Assembly:  System.Xml (in System.Xml.dll)

public virtual bool IsDescendant(
	XPathNavigator nav
)

Parameters

nav
Type: System.Xml.XPath.XPathNavigator

The XPathNavigator to compare to this XPathNavigator.

Return Value

Type: System.Boolean

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

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.

.NET Framework
Available since 1.1
Silverlight
Available since 4.0
Return to top
Show: