System.Xml.XPath.XPathNavigator.UnderlyingObject Property

Used by System.Xml.XPath.XPathNavigator implementations which provide a "virtualized" XML view over a store, to provide access to underlying objects.

Syntax

public virtual object UnderlyingObject { get; }

Value

Documentation for this section has not yet been entered.

Remarks

The XPathNavigator.UnderlyingObject property can be used by System.Xml.XPath.XPathNavigator implementations which provide a "virtualized" XML view over a store, to provide access to underlying objects. For example, if an System.Xml.XPath.XPathNavigator object is used to provide a virtual XML view over a Common Language Runtime (CLR) object graph, you may wish to perform XPath queries using the erload:System.Xml.XPath.XPathNavigator.Select method and then access the CLR objects underlying the selected nodes. The XPathNavigator.UnderlyingObject property would expose these underlying objects.

In many cases, this value will be null, and the object returned by the XPathNavigator.UnderlyingObject property will always be implementation specific.

The XPathNavigator.UnderlyingObject property should preserve object identity and should only be used to return objects that have a one-to-one correspondence to their respective overlaid items. A user should always get the same object on successive visits to the same node using the same System.Xml.XPath.XPathNavigator object or a cloned one.

Note:

The XPathNavigator.UnderlyingObject property of an System.Xml.XPath.XPathNavigator object created by an System.Xml.XmlDocument object returns the corresponding System.Xml.XmlNode.

Requirements

Namespace: System.Xml.XPath
Assembly: System.Xml (in System.Xml.dll)
Assembly Versions: 2.0.0.0, 4.0.0.0
Since: .NET 2.0