Provides a cursor model for navigating and editing XML data. More...

#include <xpath_navigator.h>

Inherits System::Xml::XPath::XPathItem, System::Xml::XPath::IXPathNavigable, and System::Xml::IXmlNamespaceResolver.

Public Types
using	Ptr = SharedPtr< XPathNavigator >
	An alias for shared pointer to an instance of this class. More...

Public Types inherited from System::Xml::XPath::XPathItem
using	Ptr = SharedPtr< XPathItem >
	An alias for shared pointer to an instance of this class. More...

Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

Public Member Functions
bool	get_IsNode () override
	Returns a value that indicates if the current node represents an XPath node. More...

SharedPtr< System::Xml::Schema::XmlSchemaType >	get_XmlType () override
	Returns the XmlSchemaType information for the current node. More...

SharedPtr< Object >	get_TypedValue () override
	Returns the current node as a boxed object of the most appropriate type. More...

TypeInfo	get_ValueType () override
	Returns the type of the current node. More...

bool	get_ValueAsBoolean () override
	Returns the current node's value as a Boolean. More...

DateTime	get_ValueAsDateTime () override
	Returns the current node's value as a DateTime. More...

double	get_ValueAsDouble () override
	Returns the current node's value as a Double. More...

int32_t	get_ValueAsInt () override
	Returns the current node's value as an Int32. More...

int64_t	get_ValueAsLong () override
	Returns the current node's value as an Int64. More...

virtual SharedPtr< XmlNameTable >	get_NameTable ()=0
	When overridden in a derived class, gets the XmlNameTable of the XPathNavigator. More...

virtual XPathNodeType	get_NodeType ()=0
	When overridden in a derived class, gets the XPathNodeType of the current node. More...

virtual String	get_LocalName ()=0
	When overridden in a derived class, gets the XPathNavigator::get_Name of the current node without any namespace prefix. More...

virtual String	get_Name ()=0
	When overridden in a derived class, gets the qualified name of the current node. More...

virtual String	get_NamespaceURI ()=0
	When overridden in a derived class, gets the namespace URI of the current node. More...

virtual String	get_Prefix ()=0
	When overridden in a derived class, gets the namespace prefix associated with the current node. More...

virtual String	get_BaseURI ()=0
	When overridden in a derived class, gets the base URI for the current node. More...

virtual bool	get_IsEmptyElement ()=0
	When overridden in a derived class, gets a value that indicates whether the current node is an empty element without an end element tag. More...

virtual String	get_XmlLang ()
	Returns the `xml:lang` scope for the current node. More...

virtual SharedPtr< Object >	get_UnderlyingObject ()
	Used by XPathNavigator implementations which provide a "virtualized" XML view over a store, to provide access to underlying objects. More...

virtual bool	get_HasAttributes ()
	Returns a value that indicates whether the current node has any attributes. More...

virtual bool	get_HasChildren ()
	Returns a value that indicates whether the current node has any child nodes. More...

virtual SharedPtr< System::Xml::Schema::IXmlSchemaInfo >	get_SchemaInfo ()
	Returns the schema information that has been assigned to the current node as a result of schema validation. More...

virtual bool	get_CanEdit ()
	Returns a value that indicates whether the XPathNavigator can edit the underlying XML data. More...

virtual String	get_OuterXml ()
	Returns the markup representing the opening and closing tags of the current node and its child nodes. More...

virtual void	set_OuterXml (String value)
	Sets the markup representing the opening and closing tags of the current node and its child nodes. More...

virtual String	get_InnerXml ()
	Returns the markup representing the child nodes of the current node. More...

virtual void	set_InnerXml (String value)
	Sets the markup representing the child nodes of the current node. More...

virtual void	SetValue (String value)
	Sets the value of the current node. More...

virtual void	SetTypedValue (SharedPtr< Object > typedValue)
	Sets the typed value of the current node. More...

SharedPtr< Object >	ValueAs (const TypeInfo &returnType, SharedPtr< IXmlNamespaceResolver > nsResolver) override
	Returns the current node's value as the Type specified, using the IXmlNamespaceResolver object specified to resolve namespace prefixes. More...

SharedPtr< XPathNavigator >	CreateNavigator () override
	Returns a copy of the XPathNavigator. More...

String	LookupNamespace (const String &prefix) override
	Returns the namespace URI for the specified prefix. More...

String	LookupPrefix (const String &namespaceURI) override
	Returns the prefix declared for the specified namespace URI. More...

SharedPtr< Collections::Generic::IDictionary< String, String > >	GetNamespacesInScope (XmlNamespaceScope scope) override
	Returns the in-scope namespaces of the current node. More...

virtual SharedPtr< XPathNavigator >	Clone ()=0
	When overridden in a derived class, creates a new XPathNavigator positioned at the same node as this XPathNavigator. More...

virtual SharedPtr< XmlReader >	ReadSubtree ()
	Returns an XmlReader object that contains the current node and its child nodes. More...

virtual void	WriteSubtree (SharedPtr< XmlWriter > writer)
	Streams the current node and its child nodes to the XmlWriter object specified. More...

virtual String	GetAttribute (String localName, String namespaceURI)
	Returns the value of the attribute with the specified local name and namespace URI. More...

virtual bool	MoveToAttribute (String localName, String namespaceURI)
	Moves the XPathNavigator to the attribute with the matching local name and namespace URI. More...

virtual bool	MoveToFirstAttribute ()=0
	When overridden in a derived class, moves the XPathNavigator to the first attribute of the current node. More...

virtual bool	MoveToNextAttribute ()=0
	When overridden in a derived class, moves the XPathNavigator to the next attribute. More...

virtual String	GetNamespace (String name)
	Returns the value of the namespace node corresponding to the specified local name. More...

virtual bool	MoveToNamespace (String name)
	Moves the XPathNavigator to the namespace node with the specified namespace prefix. More...

virtual bool	MoveToFirstNamespace (XPathNamespaceScope namespaceScope)=0
	When overridden in a derived class, moves the XPathNavigator to the first namespace node that matches the XPathNamespaceScope specified. More...

virtual bool	MoveToNextNamespace (XPathNamespaceScope namespaceScope)=0
	When overridden in a derived class, moves the XPathNavigator to the next namespace node matching the XPathNamespaceScope specified. More...

bool	MoveToFirstNamespace ()
	Moves the XPathNavigator to first namespace node of the current node. More...

bool	MoveToNextNamespace ()
	Moves the XPathNavigator to the next namespace node. More...

virtual bool	MoveToNext ()=0
	When overridden in a derived class, moves the XPathNavigator to the next sibling node of the current node. More...

virtual bool	MoveToPrevious ()=0
	When overridden in a derived class, moves the XPathNavigator to the previous sibling node of the current node. More...

virtual bool	MoveToFirst ()
	Moves the XPathNavigator to the first sibling node of the current node. More...

virtual bool	MoveToFirstChild ()=0
	When overridden in a derived class, moves the XPathNavigator to the first child node of the current node. More...

virtual bool	MoveToParent ()=0
	When overridden in a derived class, moves the XPathNavigator to the parent node of the current node. More...

virtual void	MoveToRoot ()
	Moves the XPathNavigator to the root node that the current node belongs to. More...

virtual bool	MoveTo (SharedPtr< XPathNavigator > other)=0
	When overridden in a derived class, moves the XPathNavigator to the same position as the specified XPathNavigator. More...

virtual bool	MoveToId (String id)=0
	When overridden in a derived class, moves to the node that has an attribute of type `ID` whose value matches the specified String. More...

virtual bool	MoveToChild (String localName, String namespaceURI)
	Moves the XPathNavigator to the child node with the local name and namespace URI specified. More...

virtual bool	MoveToChild (XPathNodeType type)
	Moves the XPathNavigator to the child node of the XPathNodeType specified. More...

virtual bool	MoveToFollowing (String localName, String namespaceURI)
	Moves the XPathNavigator to the element with the local name and namespace URI specified in document order. More...

virtual bool	MoveToFollowing (String localName, String namespaceURI, SharedPtr< XPathNavigator > end)
	Moves the XPathNavigator to the element with the local name and namespace URI specified, to the boundary specified, in document order. More...

virtual bool	MoveToFollowing (XPathNodeType type)
	Moves the XPathNavigator to the following element of the XPathNodeType specified in document order. More...

virtual bool	MoveToFollowing (XPathNodeType type, SharedPtr< XPathNavigator > end)
	Moves the XPathNavigator to the following element of the XPathNodeType specified, to the boundary specified, in document order. More...

virtual bool	MoveToNext (String localName, String namespaceURI)
	Moves the XPathNavigator to the next sibling node with the local name and namespace URI specified. More...

virtual bool	MoveToNext (XPathNodeType type)
	Moves the XPathNavigator to the next sibling node of the current node that matches the XPathNodeType specified. More...

virtual bool	IsSamePosition (SharedPtr< XPathNavigator > other)=0
	When overridden in a derived class, determines whether the current XPathNavigator is at the same position as the specified XPathNavigator. More...

virtual bool	IsDescendant (SharedPtr< XPathNavigator > nav)
	Determines whether the specified XPathNavigator is a descendant of the current XPathNavigator. More...

virtual XmlNodeOrder	ComparePosition (SharedPtr< XPathNavigator > nav)
	Compares the position of the current XPathNavigator with the position of the XPathNavigator specified. More...

virtual bool	CheckValidity (SharedPtr< System::Xml::Schema::XmlSchemaSet > schemas, System::Xml::Schema::ValidationEventHandler validationEventHandler)
	Verifies that the XML data in the XPathNavigator conforms to the XML Schema definition language (XSD) schema provided. More...

virtual SharedPtr< XPathExpression >	Compile (String xpath)
	Compiles a string representing an XPath expression and returns an XPathExpression object. More...

virtual SharedPtr< XPathNavigator >	SelectSingleNode (String xpath)
	Selects a single node in the XPathNavigator using the specified XPath query. More...

virtual SharedPtr< XPathNavigator >	SelectSingleNode (String xpath, SharedPtr< IXmlNamespaceResolver > resolver)
	Selects a single node in the XPathNavigator object using the specified XPath query with the IXmlNamespaceResolver object specified to resolve namespace prefixes. More...

virtual SharedPtr< XPathNavigator >	SelectSingleNode (SharedPtr< XPathExpression > expression)
	Selects a single node in the XPathNavigator using the specified XPathExpression object. More...

virtual SharedPtr< XPathNodeIterator >	Select (String xpath)
	Selects a node set, using the specified XPath expression. More...

virtual SharedPtr< XPathNodeIterator >	Select (String xpath, SharedPtr< IXmlNamespaceResolver > resolver)
	Selects a node set using the specified XPath expression with the IXmlNamespaceResolver object specified to resolve namespace prefixes. More...

virtual SharedPtr< XPathNodeIterator >	Select (SharedPtr< XPathExpression > expr)
	Selects a node set using the specified XPathExpression. More...

virtual SharedPtr< Object >	Evaluate (String xpath)
	Evaluates the specified XPath expression and returns the typed result. More...

virtual SharedPtr< Object >	Evaluate (String xpath, SharedPtr< IXmlNamespaceResolver > resolver)
	Evaluates the specified XPath expression and returns the typed result, using the IXmlNamespaceResolver object specified to resolve namespace prefixes in the XPath expression. More...

virtual SharedPtr< Object >	Evaluate (SharedPtr< XPathExpression > expr)
	Evaluates the XPathExpression and returns the typed result. More...

virtual SharedPtr< Object >	Evaluate (SharedPtr< XPathExpression > expr, SharedPtr< XPathNodeIterator > context)
	Uses the supplied context to evaluate the XPathExpression, and returns the typed result. More...

virtual bool	Matches (SharedPtr< XPathExpression > expr)
	Determines whether the current node matches the specified XPathExpression. More...

virtual bool	Matches (String xpath)
	Determines whether the current node matches the specified XPath expression. More...

virtual SharedPtr< XPathNodeIterator >	SelectChildren (XPathNodeType type)
	Selects all the child nodes of the current node that have the matching XPathNodeType. More...

virtual SharedPtr< XPathNodeIterator >	SelectChildren (String name, String namespaceURI)
	Selects all the child nodes of the current node that have the local name and namespace URI specified. More...

virtual SharedPtr< XPathNodeIterator >	SelectAncestors (XPathNodeType type, bool matchSelf)
	Selects all the ancestor nodes of the current node that have a matching XPathNodeType. More...

virtual SharedPtr< XPathNodeIterator >	SelectAncestors (String name, String namespaceURI, bool matchSelf)
	Selects all the ancestor nodes of the current node that have the specified local name and namespace URI. More...

virtual SharedPtr< XPathNodeIterator >	SelectDescendants (XPathNodeType type, bool matchSelf)
	Selects all the descendant nodes of the current node that have a matching XPathNodeType. More...

virtual SharedPtr< XPathNodeIterator >	SelectDescendants (String name, String namespaceURI, bool matchSelf)
	Selects all the descendant nodes of the current node with the local name and namespace URI specified. More...

virtual SharedPtr< XmlWriter >	PrependChild ()
	Returns an XmlWriter object used to create a new child node at the beginning of the list of child nodes of the current node. More...

virtual SharedPtr< XmlWriter >	AppendChild ()
	Returns an XmlWriter object used to create one or more new child nodes at the end of the list of child nodes of the current node. More...

virtual SharedPtr< XmlWriter >	InsertAfter ()
	Returns an XmlWriter object used to create a new sibling node after the currently selected node. More...

virtual SharedPtr< XmlWriter >	InsertBefore ()
	Returns an XmlWriter object used to create a new sibling node before the currently selected node. More...

virtual SharedPtr< XmlWriter >	CreateAttributes ()
	Returns an XmlWriter object used to create new attributes on the current element. More...

virtual SharedPtr< XmlWriter >	ReplaceRange (SharedPtr< XPathNavigator > lastSiblingToReplace)
	Replaces a range of sibling nodes from the current node to the node specified. More...

virtual void	ReplaceSelf (String newNode)
	Replaces the current node with the content of the string specified. More...

virtual void	ReplaceSelf (SharedPtr< XmlReader > newNode)
	Replaces the current node with the contents of the XmlReader object specified. More...

virtual void	ReplaceSelf (SharedPtr< XPathNavigator > newNode)
	Replaces the current node with the contents of the XPathNavigator object specified. More...

virtual void	AppendChild (String newChild)
	Creates a new child node at the end of the list of child nodes of the current node using the XML data string specified. More...

virtual void	AppendChild (SharedPtr< XmlReader > newChild)
	Creates a new child node at the end of the list of child nodes of the current node using the XML contents of the XmlReader object specified. More...

virtual void	AppendChild (SharedPtr< XPathNavigator > newChild)
	Creates a new child node at the end of the list of child nodes of the current node using the nodes in the XPathNavigator specified. More...

virtual void	PrependChild (String newChild)
	Creates a new child node at the beginning of the list of child nodes of the current node using the XML string specified. More...

virtual void	PrependChild (SharedPtr< XmlReader > newChild)
	Creates a new child node at the beginning of the list of child nodes of the current node using the XML contents of the XmlReader object specified. More...

virtual void	PrependChild (SharedPtr< XPathNavigator > newChild)
	Creates a new child node at the beginning of the list of child nodes of the current node using the nodes in the XPathNavigator object specified. More...

virtual void	InsertBefore (String newSibling)
	Creates a new sibling node before the currently selected node using the XML string specified. More...

virtual void	InsertBefore (SharedPtr< XmlReader > newSibling)
	Creates a new sibling node before the currently selected node using the XML contents of the XmlReader object specified. More...

virtual void	InsertBefore (SharedPtr< XPathNavigator > newSibling)
	Creates a new sibling node before the currently selected node using the nodes in the XPathNavigator specified. More...

virtual void	InsertAfter (String newSibling)
	Creates a new sibling node after the currently selected node using the XML string specified. More...

virtual void	InsertAfter (SharedPtr< XmlReader > newSibling)
	Creates a new sibling node after the currently selected node using the XML contents of the XmlReader object specified. More...

virtual void	InsertAfter (SharedPtr< XPathNavigator > newSibling)
	Creates a new sibling node after the currently selected node using the nodes in the XPathNavigator object specified. More...

virtual void	DeleteRange (SharedPtr< XPathNavigator > lastSiblingToDelete)
	Deletes a range of sibling nodes from the current node to the node specified. More...

virtual void	DeleteSelf ()
	Deletes the current node and its child nodes. More...

virtual void	PrependChildElement (String prefix, String localName, String namespaceURI, String value)
	Creates a new child element at the beginning of the list of child nodes of the current node using the namespace prefix, local name, and namespace URI specified with the value specified. More...

virtual void	AppendChildElement (String prefix, String localName, String namespaceURI, String value)
	Creates a new child element node at the end of the list of child nodes of the current node using the namespace prefix, local name and namespace URI specified with the value specified. More...

virtual void	InsertElementBefore (String prefix, String localName, String namespaceURI, String value)
	Creates a new sibling element before the current node using the namespace prefix, local name, and namespace URI specified, with the value specified. More...

virtual void	InsertElementAfter (String prefix, String localName, String namespaceURI, String value)
	Creates a new sibling element after the current node using the namespace prefix, local name and namespace URI specified, with the value specified. More...

virtual void	CreateAttribute (String prefix, String localName, String namespaceURI, String value)
	Creates an attribute node on the current element node using the namespace prefix, local name and namespace URI specified with the value specified. More...

String	ToString () const override
	Returns the text value of the current node. More...

Public Member Functions inherited from System::Xml::XPath::XPathItem
virtual bool	get_IsNode ()=0
	When overridden in a derived class, gets a value indicating whether the item represents an XPath node or an atomic value. More...

virtual SharedPtr< System::Xml::Schema::XmlSchemaType >	get_XmlType ()=0
	When overridden in a derived class, gets the XmlSchemaType for the item. More...

virtual String	get_Value ()=0
	When overridden in a derived class, gets the `string` value of the item. More...

virtual SharedPtr< Object >	get_TypedValue ()=0
	When overridden in a derived class, gets the current item as a boxed object of the most appropriate type according to its schema type. More...

virtual TypeInfo	get_ValueType ()=0
	When overridden in a derived class, gets the type of the item. More...

virtual bool	get_ValueAsBoolean ()=0
	When overridden in a derived class, gets the item's value as a Boolean. More...

virtual DateTime	get_ValueAsDateTime ()=0
	When overridden in a derived class, gets the item's value as a DateTime. More...

virtual double	get_ValueAsDouble ()=0
	When overridden in a derived class, gets the item's value as a Double. More...

virtual int32_t	get_ValueAsInt ()=0
	When overridden in a derived class, gets the item's value as an Int32. More...

virtual int64_t	get_ValueAsLong ()=0
	When overridden in a derived class, gets the item's value as an Int64. More...

virtual SharedPtr< Object >	ValueAs (const TypeInfo &returnType)
	Returns the item's value as the specified type. More...

virtual SharedPtr< Object >	ValueAs (const TypeInfo &returnType, SharedPtr< IXmlNamespaceResolver > nsResolver)=0
	When overridden in a derived class, returns the item's value as the type specified using the IXmlNamespaceResolver object specified to resolve namespace prefixes. More...

Public Member Functions inherited from System::Object
	Object ()
	Creates object. Initializes all internal data structures. More...

virtual	~Object ()
	Destroys object. Frees all internal data structures. More...

	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	SharedRefRemovedSafe ()
	Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value. More...

Detail::SmartPtrCounter *	WeakRefAdded ()
	Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

void	WeakRefRemoved ()
	Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object. More...

int	SharedCount () const
	Gets current value of shared reference counter. More...

void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...

void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...

virtual bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics. More...

virtual int32_t	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...

virtual String	ToString () const
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...

virtual ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...

virtual const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call. More...

virtual bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...

virtual void	SetTemplateWeakPtr (uint32_t argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...

virtual bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only. More...

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)
	Specialization of Object::ReferenceEquals for case of string and nullptr. More...

template<>
bool	ReferenceEquals (String const &str1, String const &str2)
	Specialization of Object::ReferenceEquals for case of strings. More...

virtual SharedPtr< XPathNavigator >	CreateNavigator ()=0
	Returns a new XPathNavigator object. More...

virtual SharedPtr< Collections::Generic::IDictionary< String, String > >	GetNamespacesInScope (XmlNamespaceScope scope)=0
	Returns a collection of defined prefix-namespace mappings that are currently in scope. More...

virtual String	LookupNamespace (const String &prefix)=0
	Returns the namespace URI mapped to the specified prefix. More...

virtual String	LookupPrefix (const String &namespaceName)=0
	Returns the prefix that is mapped to the specified namespace URI. More...

Static Public Member Functions
static SharedPtr< Collections::Generic::IEqualityComparer< SharedPtr< XPathNavigator > > >	get_NavigatorComparer ()
	Returns an Collections::IEqualityComparer used for equality comparison of XPathNavigator objects. More...

Static Public Member Functions inherited from System::Object
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr. More...

template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style. More...

template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style. More...

static const TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...

template<>
bool	Equals (float const &objA, float const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

template<>
bool	Equals (double const &objA, double const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

Protected Member Functions
virtual	~XPathNavigator ()

Detailed Description

Provides a cursor model for navigating and editing XML data.

Member Typedef Documentation

◆ Ptr

using System::Xml::XPath::XPathNavigator::Ptr = SharedPtr<XPathNavigator>

An alias for shared pointer to an instance of this class.

Constructor & Destructor Documentation

◆ ~XPathNavigator()

virtual System::Xml::XPath::XPathNavigator::~XPathNavigator ( )

protectedvirtual

Member Function Documentation

◆ AppendChild() [1/4]

virtual SharedPtr< XmlWriter > System::Xml::XPath::XPathNavigator::AppendChild ( )

virtual

Returns an XmlWriter object used to create one or more new child nodes at the end of the list of child nodes of the current node.

Returns: An XmlWriter object used to create new child nodes at the end of the list of child nodes of the current node.

Exceptions

InvalidOperationException	The current node the XPathNavigator is positioned on is not the root node or an element node.
NotSupportedException	The XPathNavigator does not support editing.

◆ AppendChild() [2/4]

virtual void System::Xml::XPath::XPathNavigator::AppendChild ( SharedPtr< XmlReader > newChild )

virtual

Creates a new child node at the end of the list of child nodes of the current node using the XML contents of the XmlReader object specified.

Parameters

newChild An XmlReader object positioned on the XML data for the new child node.

Exceptions

ArgumentException	The XmlReader object is in an error state or closed.
ArgumentNullException	The XmlReader object parameter is `nullptr`.
InvalidOperationException	The current node the XPathNavigator is positioned on is not the root node or an element node.
NotSupportedException	The XPathNavigator does not support editing.
XmlException	The XML contents of the XmlReader object parameter is not well-formed.

◆ AppendChild() [3/4]

virtual void System::Xml::XPath::XPathNavigator::AppendChild ( SharedPtr< XPathNavigator > newChild )

virtual

Creates a new child node at the end of the list of child nodes of the current node using the nodes in the XPathNavigator specified.

Parameters

newChild An XPathNavigator object positioned on the node to add as the new child node.

Exceptions

ArgumentNullException	The XPathNavigator object parameter is `nullptr`.
InvalidOperationException	The current node the XPathNavigator is positioned on is not the root node or an element node.
NotSupportedException	The XPathNavigator does not support editing.

◆ AppendChild() [4/4]

virtual void System::Xml::XPath::XPathNavigator::AppendChild ( String newChild )

virtual

Creates a new child node at the end of the list of child nodes of the current node using the XML data string specified.

Parameters

newChild The XML data string for the new child node.

Exceptions

ArgumentNullException	The XML data string parameter is `nullptr`.
InvalidOperationException	The current node the XPathNavigator is positioned on is not the root node or an element node.
NotSupportedException	The XPathNavigator does not support editing.
XmlException	The XML data string parameter is not well-formed.

◆ AppendChildElement()

virtual void System::Xml::XPath::XPathNavigator::AppendChildElement	(	String	prefix,
		String	localName,
		String	namespaceURI,
		String	value
	)

virtual

Creates a new child element node at the end of the list of child nodes of the current node using the namespace prefix, local name and namespace URI specified with the value specified.

Parameters

prefix	The namespace prefix of the new child element node (if any).
localName	The local name of the new child element node (if any).
namespaceURI	The namespace URI of the new child element node (if any). String::Empty and `nullptr` are equivalent.
value	The value of the new child element node. If String::Empty or `nullptr` are passed, an empty element is created.

Exceptions

InvalidOperationException	The current node the XPathNavigator is positioned on is not the root node or an element node.
NotSupportedException	The XPathNavigator does not support editing.

◆ CheckValidity()

virtual bool System::Xml::XPath::XPathNavigator::CheckValidity	(	SharedPtr< System::Xml::Schema::XmlSchemaSet >	schemas,
		System::Xml::Schema::ValidationEventHandler	validationEventHandler
	)

virtual

Verifies that the XML data in the XPathNavigator conforms to the XML Schema definition language (XSD) schema provided.

Parameters

schemas	The XmlSchemaSet containing the schemas used to validate the XML data contained in the XPathNavigator.
validationEventHandler	The ValidationEventHandler that receives information about schema validation warnings and errors.

Returns: true if no schema validation errors occurred; otherwise, false.

Exceptions

XmlSchemaValidationException	A schema validation error occurred, and no ValidationEventHandler was specified to handle validation errors.
InvalidOperationException	The XPathNavigator is positioned on a node that is not an element, attribute, or the root node or there is not type information to perform validation.
ArgumentException	The method was called with an XmlSchemaSet parameter when the XPathNavigator was not positioned on the root node of the XML data.

◆ Clone()

virtual SharedPtr< XPathNavigator > System::Xml::XPath::XPathNavigator::Clone ( )

pure virtual

When overridden in a derived class, creates a new XPathNavigator positioned at the same node as this XPathNavigator.

Returns: A new XPathNavigator positioned at the same node as this XPathNavigator.

◆ ComparePosition()

virtual XmlNodeOrder System::Xml::XPath::XPathNavigator::ComparePosition ( SharedPtr< XPathNavigator > nav )

virtual

Compares the position of the current XPathNavigator with the position of the XPathNavigator specified.

Parameters

nav	The XPathNavigator to compare against.

Returns: An XmlNodeOrder value representing the comparative position of the two XPathNavigator objects.

◆ Compile()

virtual SharedPtr< XPathExpression > System::Xml::XPath::XPathNavigator::Compile ( String xpath )

virtual

Compiles a string representing an XPath expression and returns an XPathExpression object.

Parameters

xpath A string representing an XPath expression.

Returns: An XPathExpression object representing the XPath expression.

Exceptions

ArgumentException	The `xpath` parameter contains an XPath expression that is not valid.
XPathException	The XPath expression is not valid.

◆ CreateAttribute()

virtual void System::Xml::XPath::XPathNavigator::CreateAttribute	(	String	prefix,
		String	localName,
		String	namespaceURI,
		String	value
	)

virtual

Creates an attribute node on the current element node using the namespace prefix, local name and namespace URI specified with the value specified.

Parameters

prefix	The namespace prefix of the new attribute node (if any).
localName	The local name of the new attribute node which cannot String::Empty or `nullptr`.
namespaceURI	The namespace URI for the new attribute node (if any).
value	The value of the new attribute node. If String::Empty or `nullptr` are passed, an empty attribute node is created.

Exceptions

InvalidOperationException	The XPathNavigator is not positioned on an element node.
NotSupportedException	The XPathNavigator does not support editing.

◆ CreateAttributes()

virtual SharedPtr< XmlWriter > System::Xml::XPath::XPathNavigator::CreateAttributes ( )

virtual

Returns an XmlWriter object used to create new attributes on the current element.

Returns: An XmlWriter object used to create new attributes on the current element.

Exceptions

InvalidOperationException	The XPathNavigator is not positioned on an element node.
NotSupportedException	The XPathNavigator does not support editing.

◆ CreateNavigator()

SharedPtr< XPathNavigator > System::Xml::XPath::XPathNavigator::CreateNavigator ( )

overridevirtual

Returns a copy of the XPathNavigator.

Returns: An XPathNavigator copy of this XPathNavigator.

Implements System::Xml::XPath::IXPathNavigable.

◆ DeleteRange()

virtual void System::Xml::XPath::XPathNavigator::DeleteRange ( SharedPtr< XPathNavigator > lastSiblingToDelete )

virtual

Deletes a range of sibling nodes from the current node to the node specified.

Parameters

lastSiblingToDelete An XPathNavigator positioned on the last sibling node in the range to delete.

Exceptions

ArgumentNullException	The XPathNavigator specified is `nullptr`.
NotSupportedException	The XPathNavigator does not support editing.
InvalidOperationException	The last node to delete specified is not a valid sibling node of the current node.

◆ DeleteSelf()

virtual void System::Xml::XPath::XPathNavigator::DeleteSelf ( )

virtual

Deletes the current node and its child nodes.

Exceptions

InvalidOperationException	The XPathNavigator is positioned on a node that cannot be deleted such as the root node or a namespace node.
NotSupportedException	The XPathNavigator does not support editing.

◆ Evaluate() [1/4]

virtual SharedPtr< Object > System::Xml::XPath::XPathNavigator::Evaluate ( SharedPtr< XPathExpression > expr )

virtual

Evaluates the XPathExpression and returns the typed result.

Parameters

expr	An XPathExpression that can be evaluated.

Returns: The result of the expression (Boolean, number, string, or node set). This maps to Boolean, Double, String, or XPathNodeIterator objects respectively.

Exceptions

ArgumentException	The return type of the XPath expression is a node set.
XPathException	The XPath expression is not valid.

◆ Evaluate() [2/4]

virtual SharedPtr< Object > System::Xml::XPath::XPathNavigator::Evaluate	(	SharedPtr< XPathExpression >	expr,
		SharedPtr< XPathNodeIterator >	context
	)

virtual

Uses the supplied context to evaluate the XPathExpression, and returns the typed result.

Parameters

expr	An XPathExpression that can be evaluated.
context	An XPathNodeIterator that points to the selected node set that the evaluation is to be performed on.

Returns: The result of the expression (Boolean, number, string, or node set). This maps to Boolean, Double, String, or XPathNodeIterator objects respectively.

Exceptions

ArgumentException	The return type of the XPath expression is a node set.
XPathException	The XPath expression is not valid.

◆ Evaluate() [3/4]

virtual SharedPtr< Object > System::Xml::XPath::XPathNavigator::Evaluate ( String xpath )

virtual

Evaluates the specified XPath expression and returns the typed result.

Parameters

xpath A string representing an XPath expression that can be evaluated.

Returns: The result of the expression (Boolean, number, string, or node set). This maps to Boolean, Double, String, or XPathNodeIterator objects respectively.

Exceptions

ArgumentException	The return type of the XPath expression is a node set.
XPathException	The XPath expression is not valid.

◆ Evaluate() [4/4]

virtual SharedPtr< Object > System::Xml::XPath::XPathNavigator::Evaluate	(	String	xpath,
		SharedPtr< IXmlNamespaceResolver >	resolver
	)

virtual

Evaluates the specified XPath expression and returns the typed result, using the IXmlNamespaceResolver object specified to resolve namespace prefixes in the XPath expression.

Parameters

xpath	A string representing an XPath expression that can be evaluated.
resolver	The IXmlNamespaceResolver object used to resolve namespace prefixes in the XPath expression.

Returns: The result of the expression (Boolean, number, string, or node set). This maps to Boolean, Double, String, or XPathNodeIterator objects respectively.

Exceptions

ArgumentException	The return type of the XPath expression is a node set.
XPathException	The XPath expression is not valid.

◆ get_BaseURI()

virtual String System::Xml::XPath::XPathNavigator::get_BaseURI ( )

pure virtual

When overridden in a derived class, gets the base URI for the current node.

Returns: The location from which the node was loaded, or String::Empty if there is no value.

◆ get_CanEdit()

virtual bool System::Xml::XPath::XPathNavigator::get_CanEdit ( )

virtual

Returns a value that indicates whether the XPathNavigator can edit the underlying XML data.

Returns: true if the XPathNavigator can edit the underlying XML data; otherwise, false.

◆ get_HasAttributes()

virtual bool System::Xml::XPath::XPathNavigator::get_HasAttributes ( )

virtual

Returns a value that indicates whether the current node has any attributes.

Returns: true if the current node has attributes; returns false if the current node has no attributes, or if the XPathNavigator is not positioned on an element node.

◆ get_HasChildren()

virtual bool System::Xml::XPath::XPathNavigator::get_HasChildren ( )

virtual

Returns a value that indicates whether the current node has any child nodes.

Returns: true if the current node has any child nodes; otherwise, false.

◆ get_InnerXml()

virtual String System::Xml::XPath::XPathNavigator::get_InnerXml ( )

virtual

Returns the markup representing the child nodes of the current node.

Returns: A String that contains the markup of the child nodes of the current node.

◆ get_IsEmptyElement()

virtual bool System::Xml::XPath::XPathNavigator::get_IsEmptyElement ( )

pure virtual

When overridden in a derived class, gets a value that indicates whether the current node is an empty element without an end element tag.

Returns: true if the current node is an empty element; otherwise, false.

◆ get_IsNode()

bool System::Xml::XPath::XPathNavigator::get_IsNode ( )

overridevirtual

Returns a value that indicates if the current node represents an XPath node.

Returns: Always returns true.

Implements System::Xml::XPath::XPathItem.

◆ get_LocalName()

virtual String System::Xml::XPath::XPathNavigator::get_LocalName ( )

pure virtual

When overridden in a derived class, gets the XPathNavigator::get_Name of the current node without any namespace prefix.

Returns: A String that contains the local name of the current node, or String::Empty if the current node does not have a name (for example, text or comment nodes).

◆ get_Name()

virtual String System::Xml::XPath::XPathNavigator::get_Name ( )

pure virtual

When overridden in a derived class, gets the qualified name of the current node.

Returns: A String that contains the qualified XPathNavigator::get_Name of the current node, or String::Empty if the current node does not have a name (for example, text or comment nodes).

◆ get_NamespaceURI()

virtual String System::Xml::XPath::XPathNavigator::get_NamespaceURI ( )

pure virtual

When overridden in a derived class, gets the namespace URI of the current node.

Returns: A String that contains the namespace URI of the current node, or String::Empty if the current node has no namespace URI.

◆ get_NameTable()

virtual SharedPtr< XmlNameTable > System::Xml::XPath::XPathNavigator::get_NameTable ( )

pure virtual

When overridden in a derived class, gets the XmlNameTable of the XPathNavigator.

Returns: An XmlNameTable object enabling you to get the atomized version of a String within the XML document.

◆ get_NavigatorComparer()

static SharedPtr< Collections::Generic::IEqualityComparer< SharedPtr< XPathNavigator > > > System::Xml::XPath::XPathNavigator::get_NavigatorComparer ( )

static

Returns an Collections::IEqualityComparer used for equality comparison of XPathNavigator objects.

Returns: An Collections::IEqualityComparer used for equality comparison of XPathNavigator objects.

◆ get_NodeType()

virtual XPathNodeType System::Xml::XPath::XPathNavigator::get_NodeType ( )

pure virtual

When overridden in a derived class, gets the XPathNodeType of the current node.

Returns: One of the XPathNodeType values representing the current node.

◆ get_OuterXml()

virtual String System::Xml::XPath::XPathNavigator::get_OuterXml ( )

virtual

Returns the markup representing the opening and closing tags of the current node and its child nodes.

Returns: A String that contains the markup representing the opening and closing tags of the current node and its child nodes.

◆ get_Prefix()

virtual String System::Xml::XPath::XPathNavigator::get_Prefix ( )

pure virtual

When overridden in a derived class, gets the namespace prefix associated with the current node.

Returns: A String that contains the namespace prefix associated with the current node.

◆ get_SchemaInfo()

virtual SharedPtr< System::Xml::Schema::IXmlSchemaInfo > System::Xml::XPath::XPathNavigator::get_SchemaInfo ( )

virtual

Returns the schema information that has been assigned to the current node as a result of schema validation.

Returns: An IXmlSchemaInfo object that contains the schema information for the current node.

◆ get_TypedValue()

SharedPtr< Object > System::Xml::XPath::XPathNavigator::get_TypedValue ( )

overridevirtual

Returns the current node as a boxed object of the most appropriate type.

Returns: The current node as a boxed object of the most appropriate type.

Implements System::Xml::XPath::XPathItem.

◆ get_UnderlyingObject()

virtual SharedPtr< Object > System::Xml::XPath::XPathNavigator::get_UnderlyingObject ( )

virtual

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

Returns: The default is nullptr.

◆ get_ValueAsBoolean()

bool System::Xml::XPath::XPathNavigator::get_ValueAsBoolean ( )

overridevirtual

Returns the current node's value as a Boolean.

Returns: The current node's value as a Boolean.

Exceptions

FormatException	The current node's string value cannot be converted to a Boolean.
InvalidCastException	The attempted cast to Boolean is not valid.

Implements System::Xml::XPath::XPathItem.

◆ get_ValueAsDateTime()

DateTime System::Xml::XPath::XPathNavigator::get_ValueAsDateTime ( )

overridevirtual

Returns the current node's value as a DateTime.

Returns: The current node's value as a DateTime.

Exceptions

FormatException	The current node's string value cannot be converted to a DateTime.
InvalidCastException	The attempted cast to DateTime is not valid.

Implements System::Xml::XPath::XPathItem.

◆ get_ValueAsDouble()

double System::Xml::XPath::XPathNavigator::get_ValueAsDouble ( )

overridevirtual

Returns the current node's value as a Double.

Returns: The current node's value as a Double.

Exceptions

FormatException	The current node's string value cannot be converted to a Double.
InvalidCastException	The attempted cast to Double is not valid.

Implements System::Xml::XPath::XPathItem.

◆ get_ValueAsInt()

int32_t System::Xml::XPath::XPathNavigator::get_ValueAsInt ( )

overridevirtual

Returns the current node's value as an Int32.

Returns: The current node's value as an Int32.

Exceptions

FormatException	The current node's string value cannot be converted to a Int32.
InvalidCastException	The attempted cast to Int32 is not valid.

Implements System::Xml::XPath::XPathItem.

◆ get_ValueAsLong()

int64_t System::Xml::XPath::XPathNavigator::get_ValueAsLong ( )

overridevirtual

Returns the current node's value as an Int64.

Returns: The current node's value as an Int64.

Exceptions

FormatException	The current node's string value cannot be converted to a Int64.
InvalidCastException	The attempted cast to Int64 is not valid.

Implements System::Xml::XPath::XPathItem.

◆ get_ValueType()

TypeInfo System::Xml::XPath::XPathNavigator::get_ValueType ( )

overridevirtual

Returns the type of the current node.

Returns: The type of the current node. The default value is String.

Implements System::Xml::XPath::XPathItem.

◆ get_XmlLang()

virtual String System::Xml::XPath::XPathNavigator::get_XmlLang ( )

virtual

Returns the xml:lang scope for the current node.

Returns: A String that contains the value of the xml:lang scope, or String::Empty if the current node has no xml:lang scope value to return.

◆ get_XmlType()

SharedPtr< System::Xml::Schema::XmlSchemaType > System::Xml::XPath::XPathNavigator::get_XmlType ( )

overridevirtual

Returns the XmlSchemaType information for the current node.

Returns: An XmlSchemaType object; default is nullptr.

Implements System::Xml::XPath::XPathItem.

◆ GetAttribute()

virtual String System::Xml::XPath::XPathNavigator::GetAttribute	(	String	localName,
		String	namespaceURI
	)

virtual

Returns the value of the attribute with the specified local name and namespace URI.

Parameters

localName	The local name of the attribute. `localName` is case-sensitive.
namespaceURI	The namespace URI of the attribute.

Returns: A String that contains the value of the specified attribute; String::Empty if a matching attribute is not found, or if the XPathNavigator is not positioned on an element node.

◆ GetNamespace()

virtual String System::Xml::XPath::XPathNavigator::GetNamespace ( String name )

virtual

Returns the value of the namespace node corresponding to the specified local name.

Parameters

name	The local name of the namespace node.

Returns: A String that contains the value of the namespace node; String::Empty if a matching namespace node is not found, or if the XPathNavigator is not positioned on an element node.

◆ GetNamespacesInScope()

SharedPtr< Collections::Generic::IDictionary< String, String > > System::Xml::XPath::XPathNavigator::GetNamespacesInScope ( XmlNamespaceScope scope )

overridevirtual

Returns the in-scope namespaces of the current node.

Parameters

scope An XmlNamespaceScope value specifying the namespaces to return.

Returns: An IDictionary collection of namespace names keyed by prefix.

Implements System::Xml::IXmlNamespaceResolver.

◆ InsertAfter() [1/4]

virtual SharedPtr< XmlWriter > System::Xml::XPath::XPathNavigator::InsertAfter ( )

virtual

Returns an XmlWriter object used to create a new sibling node after the currently selected node.

Returns: An XmlWriter object used to create a new sibling node after the currently selected node.

Exceptions

InvalidOperationException	The position of the XPathNavigator does not allow a new sibling node to be inserted after the current node.
NotSupportedException	The XPathNavigator does not support editing.

◆ InsertAfter() [2/4]

virtual void System::Xml::XPath::XPathNavigator::InsertAfter ( SharedPtr< XmlReader > newSibling )

virtual

Creates a new sibling node after the currently selected node using the XML contents of the XmlReader object specified.

Parameters

newSibling An XmlReader object positioned on the XML data for the new sibling node.

Exceptions

ArgumentException	The XmlReader object is in an error state or closed.
ArgumentNullException	The XmlReader object parameter is `nullptr`.
InvalidOperationException	The position of the XPathNavigator does not allow a new sibling node to be inserted after the current node.
NotSupportedException	The XPathNavigator does not support editing.
XmlException	The XML contents of the XmlReader object parameter is not well-formed.

◆ InsertAfter() [3/4]

virtual void System::Xml::XPath::XPathNavigator::InsertAfter ( SharedPtr< XPathNavigator > newSibling )

virtual

Creates a new sibling node after the currently selected node using the nodes in the XPathNavigator object specified.

Parameters

newSibling An XPathNavigator object positioned on the node to add as the new sibling node.

Exceptions

ArgumentNullException	The XPathNavigator object parameter is `nullptr`.
InvalidOperationException	The position of the XPathNavigator does not allow a new sibling node to be inserted after the current node.
NotSupportedException	The XPathNavigator does not support editing.

◆ InsertAfter() [4/4]

virtual void System::Xml::XPath::XPathNavigator::InsertAfter ( String newSibling )

virtual

Creates a new sibling node after the currently selected node using the XML string specified.

Parameters

newSibling The XML data string for the new sibling node.

Exceptions

ArgumentNullException	The XML string parameter is `nullptr`.
InvalidOperationException	The position of the XPathNavigator does not allow a new sibling node to be inserted after the current node.
NotSupportedException	The XPathNavigator does not support editing.
XmlException	The XML string parameter is not well-formed.

◆ InsertBefore() [1/4]

virtual SharedPtr< XmlWriter > System::Xml::XPath::XPathNavigator::InsertBefore ( )

virtual

Returns an XmlWriter object used to create a new sibling node before the currently selected node.

Returns: An XmlWriter object used to create a new sibling node before the currently selected node.

Exceptions

InvalidOperationException	The position of the XPathNavigator does not allow a new sibling node to be inserted before the current node.
NotSupportedException	The XPathNavigator does not support editing.

◆ InsertBefore() [2/4]

virtual void System::Xml::XPath::XPathNavigator::InsertBefore ( SharedPtr< XmlReader > newSibling )

virtual

Creates a new sibling node before the currently selected node using the XML contents of the XmlReader object specified.

Parameters

newSibling An XmlReader object positioned on the XML data for the new sibling node.

Exceptions

ArgumentException	The XmlReader object is in an error state or closed.
ArgumentNullException	The XmlReader object parameter is `nullptr`.
InvalidOperationException	The position of the XPathNavigator does not allow a new sibling node to be inserted before the current node.
NotSupportedException	The XPathNavigator does not support editing.
XmlException	The XML contents of the XmlReader object parameter is not well-formed.

◆ InsertBefore() [3/4]

virtual void System::Xml::XPath::XPathNavigator::InsertBefore ( SharedPtr< XPathNavigator > newSibling )

virtual

Creates a new sibling node before the currently selected node using the nodes in the XPathNavigator specified.

Parameters

newSibling An XPathNavigator object positioned on the node to add as the new sibling node.

Exceptions

ArgumentNullException	The XPathNavigator object parameter is `nullptr`.
InvalidOperationException	The position of the XPathNavigator does not allow a new sibling node to be inserted before the current node.
NotSupportedException	The XPathNavigator does not support editing.

◆ InsertBefore() [4/4]

virtual void System::Xml::XPath::XPathNavigator::InsertBefore ( String newSibling )

virtual

Creates a new sibling node before the currently selected node using the XML string specified.

Parameters

newSibling The XML data string for the new sibling node.

Exceptions

ArgumentNullException	The XML string parameter is `nullptr`.
InvalidOperationException	The position of the XPathNavigator does not allow a new sibling node to be inserted before the current node.
NotSupportedException	The XPathNavigator does not support editing.
XmlException	The XML string parameter is not well-formed.

◆ InsertElementAfter()

virtual void System::Xml::XPath::XPathNavigator::InsertElementAfter	(	String	prefix,
		String	localName,
		String	namespaceURI,
		String	value
	)

virtual

Creates a new sibling element after the current node using the namespace prefix, local name and namespace URI specified, with the value specified.

Parameters

prefix	The namespace prefix of the new child element (if any).
localName	The local name of the new child element (if any).
namespaceURI	The namespace URI of the new child element (if any). String::Empty and `nullptr` are equivalent.
value	The value of the new child element. If String::Empty or `nullptr` are passed, an empty element is created.

Exceptions

InvalidOperationException	The position of the XPathNavigator does not allow a new sibling node to be inserted after the current node.
NotSupportedException	The XPathNavigator does not support editing.

◆ InsertElementBefore()

virtual void System::Xml::XPath::XPathNavigator::InsertElementBefore	(	String	prefix,
		String	localName,
		String	namespaceURI,
		String	value
	)

virtual

Creates a new sibling element before the current node using the namespace prefix, local name, and namespace URI specified, with the value specified.

Parameters

prefix	The namespace prefix of the new child element (if any).
localName	The local name of the new child element (if any).
namespaceURI	The namespace URI of the new child element (if any). String::Empty and `nullptr` are equivalent.
value	The value of the new child element. If String::Empty or `nullptr` are passed, an empty element is created.

Exceptions

InvalidOperationException	The position of the XPathNavigator does not allow a new sibling node to be inserted before the current node.
NotSupportedException	The XPathNavigator does not support editing.

◆ IsDescendant()

virtual bool System::Xml::XPath::XPathNavigator::IsDescendant ( SharedPtr< XPathNavigator > nav )

virtual

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

Parameters

nav	The XPathNavigator to compare to this XPathNavigator.

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

◆ IsSamePosition()

virtual bool System::Xml::XPath::XPathNavigator::IsSamePosition ( SharedPtr< XPathNavigator > other )

pure virtual

When overridden in a derived class, determines whether the current XPathNavigator is at the same position as the specified XPathNavigator.

Parameters

other The XPathNavigator to compare to this XPathNavigator.

Returns: true if the two XPathNavigator objects have the same position; otherwise, false.

◆ LookupNamespace()

String System::Xml::XPath::XPathNavigator::LookupNamespace ( const String & prefix )

overridevirtual

Returns the namespace URI for the specified prefix.

Parameters

prefix The prefix whose namespace URI you want to resolve. To match the default namespace, pass String::Empty.

Returns: A String that contains the namespace URI assigned to the namespace prefix specified; nullptr if no namespace URI is assigned to the prefix specified. The String returned is atomized.

Implements System::Xml::IXmlNamespaceResolver.

◆ LookupPrefix()

String System::Xml::XPath::XPathNavigator::LookupPrefix ( const String & namespaceURI )

overridevirtual

Returns the prefix declared for the specified namespace URI.

Parameters

namespaceURI The namespace URI to resolve for the prefix.

Returns: A String that contains the namespace prefix assigned to the namespace URI specified; otherwise, String::Empty if no prefix is assigned to the namespace URI specified. The String returned is atomized.

Implements System::Xml::IXmlNamespaceResolver.

◆ Matches() [1/2]

virtual bool System::Xml::XPath::XPathNavigator::Matches ( SharedPtr< XPathExpression > expr )

virtual

Determines whether the current node matches the specified XPathExpression.

Parameters

expr	An XPathExpression object containing the compiled XPath expression.

Returns: true if the current node matches the XPathExpression; otherwise, false.

Exceptions

ArgumentException	The XPath expression cannot be evaluated.
XPathException	The XPath expression is not valid.

◆ Matches() [2/2]

virtual bool System::Xml::XPath::XPathNavigator::Matches ( String xpath )

virtual

Determines whether the current node matches the specified XPath expression.

Parameters

xpath The XPath expression.

Returns: true if the current node matches the specified XPath expression; otherwise, false.

Exceptions

ArgumentException	The XPath expression cannot be evaluated.
XPathException	The XPath expression is not valid.

◆ MoveTo()

virtual bool System::Xml::XPath::XPathNavigator::MoveTo ( SharedPtr< XPathNavigator > other )

pure virtual

When overridden in a derived class, moves the XPathNavigator to the same position as the specified XPathNavigator.

Parameters

other The XPathNavigator positioned on the node that you want to move to.

Returns: true if the XPathNavigator is successful moving to the same position as the specified XPathNavigator; otherwise, false. If false, the position of the XPathNavigator is unchanged.

◆ MoveToAttribute()

virtual bool System::Xml::XPath::XPathNavigator::MoveToAttribute	(	String	localName,
		String	namespaceURI
	)

virtual

Moves the XPathNavigator to the attribute with the matching local name and namespace URI.

Parameters

localName	The local name of the attribute.
namespaceURI	The namespace URI of the attribute; `nullptr` for an empty namespace.

Returns: true if the XPathNavigator is successful moving to the attribute; otherwise, false. If false, the position of the XPathNavigator is unchanged.

◆ MoveToChild() [1/2]

virtual bool System::Xml::XPath::XPathNavigator::MoveToChild	(	String	localName,
		String	namespaceURI
	)

virtual

Moves the XPathNavigator to the child node with the local name and namespace URI specified.

Parameters

localName	The local name of the child node to move to.
namespaceURI	The namespace URI of the child node to move to.

Returns: true if the XPathNavigator is successful moving to the child node; otherwise, false. If false, the position of the XPathNavigator is unchanged.

◆ MoveToChild() [2/2]

virtual bool System::Xml::XPath::XPathNavigator::MoveToChild ( XPathNodeType type )

virtual

Moves the XPathNavigator to the child node of the XPathNodeType specified.

Parameters

type	The XPathNodeType of the child node to move to.

Returns: true if the XPathNavigator is successful moving to the child node; otherwise, false. If false, the position of the XPathNavigator is unchanged.

◆ MoveToFirst()

virtual bool System::Xml::XPath::XPathNavigator::MoveToFirst ( )

virtual

Moves the XPathNavigator to the first sibling node of the current node.

Returns: true if the XPathNavigator is successful moving to the first sibling node of the current node; false if there is no first sibling, or if the XPathNavigator is currently positioned on an attribute node. If the XPathNavigator is already positioned on the first sibling, XPathNavigator will return true and will not move its position. If XPathNavigator::MoveToFirst returns false because there is no first sibling, or if XPathNavigator is currently positioned on an attribute, the position of the XPathNavigator is unchanged.

◆ MoveToFirstAttribute()

virtual bool System::Xml::XPath::XPathNavigator::MoveToFirstAttribute ( )

pure virtual

When overridden in a derived class, moves the XPathNavigator to the first attribute of the current node.

Returns: true if the XPathNavigator is successful moving to the first attribute of the current node; otherwise, false. If false, the position of the XPathNavigator is unchanged.

◆ MoveToFirstChild()

virtual bool System::Xml::XPath::XPathNavigator::MoveToFirstChild ( )

pure virtual

When overridden in a derived class, moves the XPathNavigator to the first child node of the current node.

Returns: true if the XPathNavigator is successful moving to the first child node of the current node; otherwise, false. If false, the position of the XPathNavigator is unchanged.

◆ MoveToFirstNamespace() [1/2]

bool System::Xml::XPath::XPathNavigator::MoveToFirstNamespace ( )

Moves the XPathNavigator to first namespace node of the current node.

Returns: true if the XPathNavigator is successful moving to the first namespace node; otherwise, false. If false, the position of the XPathNavigator is unchanged.

◆ MoveToFirstNamespace() [2/2]

virtual bool System::Xml::XPath::XPathNavigator::MoveToFirstNamespace ( XPathNamespaceScope namespaceScope )

pure virtual

When overridden in a derived class, moves the XPathNavigator to the first namespace node that matches the XPathNamespaceScope specified.

Parameters

namespaceScope An XPathNamespaceScope value describing the namespace scope.

Returns: true if the XPathNavigator is successful moving to the first namespace node; otherwise, false. If false, the position of the XPathNavigator is unchanged.

◆ MoveToFollowing() [1/4]

virtual bool System::Xml::XPath::XPathNavigator::MoveToFollowing	(	String	localName,
		String	namespaceURI
	)

virtual

Moves the XPathNavigator to the element with the local name and namespace URI specified in document order.

Parameters

localName	The local name of the element.
namespaceURI	The namespace URI of the element.

Returns: true if the XPathNavigator moved successfully; otherwise, false.

◆ MoveToFollowing() [2/4]

virtual bool System::Xml::XPath::XPathNavigator::MoveToFollowing	(	String	localName,
		String	namespaceURI,
		SharedPtr< XPathNavigator >	end
	)

virtual

Moves the XPathNavigator to the element with the local name and namespace URI specified, to the boundary specified, in document order.

Parameters

localName	The local name of the element.
namespaceURI	The namespace URI of the element.
end	The XPathNavigator object positioned on the element boundary which the current XPathNavigator will not move past while searching for the following element.

Returns: true if the XPathNavigator moved successfully; otherwise, false.

◆ MoveToFollowing() [3/4]

virtual bool System::Xml::XPath::XPathNavigator::MoveToFollowing ( XPathNodeType type )

virtual

Moves the XPathNavigator to the following element of the XPathNodeType specified in document order.

Parameters

type	The XPathNodeType of the element. The XPathNodeType cannot be XPathNodeType::Attribute or XPathNodeType::Namespace.

Returns: true if the XPathNavigator moved successfully; otherwise, false.

◆ MoveToFollowing() [4/4]

virtual bool System::Xml::XPath::XPathNavigator::MoveToFollowing	(	XPathNodeType	type,
		SharedPtr< XPathNavigator >	end
	)

virtual

Moves the XPathNavigator to the following element of the XPathNodeType specified, to the boundary specified, in document order.

Parameters

type	The XPathNodeType of the element. The XPathNodeType cannot be XPathNodeType::Attribute or XPathNodeType::Namespace.
end	The XPathNavigator object positioned on the element boundary which the current XPathNavigator will not move past while searching for the following element.

Returns: true if the XPathNavigator moved successfully; otherwise, false.

◆ MoveToId()

virtual bool System::Xml::XPath::XPathNavigator::MoveToId ( String id )

pure virtual

When overridden in a derived class, moves to the node that has an attribute of type ID whose value matches the specified String.

Parameters

id	A String representing the `ID` value of the node to which you want to move.

Returns: true if the XPathNavigator is successful moving; otherwise, false. If false, the position of the navigator is unchanged.

◆ MoveToNamespace()

virtual bool System::Xml::XPath::XPathNavigator::MoveToNamespace ( String name )

virtual

Moves the XPathNavigator to the namespace node with the specified namespace prefix.

Parameters

name	The namespace prefix of the namespace node.

Returns: true if the XPathNavigator is successful moving to the specified namespace; false if a matching namespace node was not found, or if the XPathNavigator is not positioned on an element node. If false, the position of the XPathNavigator is unchanged.

◆ MoveToNext() [1/3]

virtual bool System::Xml::XPath::XPathNavigator::MoveToNext ( )

pure virtual

When overridden in a derived class, moves the XPathNavigator to the next sibling node of the current node.

Returns: true if the XPathNavigator is successful moving to the next sibling node; otherwise false if there are no more siblings or if the XPathNavigator is currently positioned on an attribute node. If false, the position of the XPathNavigator is unchanged.

◆ MoveToNext() [2/3]

virtual bool System::Xml::XPath::XPathNavigator::MoveToNext	(	String	localName,
		String	namespaceURI
	)

virtual

Moves the XPathNavigator to the next sibling node with the local name and namespace URI specified.

Parameters

localName	The local name of the next sibling node to move to.
namespaceURI	The namespace URI of the next sibling node to move to.

Returns: true if the XPathNavigator is successful moving to the next sibling node; false if there are no more siblings, or if the XPathNavigator is currently positioned on an attribute node. If false, the position of the XPathNavigator is unchanged.

◆ MoveToNext() [3/3]

virtual bool System::Xml::XPath::XPathNavigator::MoveToNext ( XPathNodeType type )

virtual

Moves the XPathNavigator to the next sibling node of the current node that matches the XPathNodeType specified.

Parameters

type	The XPathNodeType of the sibling node to move to.

Returns: true if the XPathNavigator is successful moving to the next sibling node; otherwise, false if there are no more siblings or if the XPathNavigator is currently positioned on an attribute node. If false, the position of the XPathNavigator is unchanged.

◆ MoveToNextAttribute()

virtual bool System::Xml::XPath::XPathNavigator::MoveToNextAttribute ( )

pure virtual

When overridden in a derived class, moves the XPathNavigator to the next attribute.

Returns: true if the XPathNavigator is successful moving to the next attribute; false if there are no more attributes. If false, the position of the XPathNavigator is unchanged.

◆ MoveToNextNamespace() [1/2]

bool System::Xml::XPath::XPathNavigator::MoveToNextNamespace ( )

Moves the XPathNavigator to the next namespace node.

Returns: true if the XPathNavigator is successful moving to the next namespace node; otherwise, false. If false, the position of the XPathNavigator is unchanged.

◆ MoveToNextNamespace() [2/2]

virtual bool System::Xml::XPath::XPathNavigator::MoveToNextNamespace ( XPathNamespaceScope namespaceScope )

pure virtual

When overridden in a derived class, moves the XPathNavigator to the next namespace node matching the XPathNamespaceScope specified.

Parameters

namespaceScope An XPathNamespaceScope value describing the namespace scope.

Returns: true if the XPathNavigator is successful moving to the next namespace node; otherwise, false. If false, the position of the XPathNavigator is unchanged.

◆ MoveToParent()

virtual bool System::Xml::XPath::XPathNavigator::MoveToParent ( )

pure virtual

When overridden in a derived class, moves the XPathNavigator to the parent node of the current node.

Returns: true if the XPathNavigator is successful moving to the parent node of the current node; otherwise, false. If false, the position of the XPathNavigator is unchanged.

◆ MoveToPrevious()

virtual bool System::Xml::XPath::XPathNavigator::MoveToPrevious ( )

pure virtual

When overridden in a derived class, moves the XPathNavigator to the previous sibling node of the current node.

Returns: true if the XPathNavigator is successful moving to the previous sibling node; otherwise, false if there is no previous sibling node or if the XPathNavigator is currently positioned on an attribute node. If false, the position of the XPathNavigator is unchanged.

◆ MoveToRoot()

virtual void System::Xml::XPath::XPathNavigator::MoveToRoot ( )

virtual

Moves the XPathNavigator to the root node that the current node belongs to.

◆ PrependChild() [1/4]

virtual SharedPtr< XmlWriter > System::Xml::XPath::XPathNavigator::PrependChild ( )

virtual

Returns an XmlWriter object used to create a new child node at the beginning of the list of child nodes of the current node.

Returns: An XmlWriter object used to create a new child node at the beginning of the list of child nodes of the current node.

Exceptions

InvalidOperationException	The current node the XPathNavigator is positioned on does not allow a new child node to be prepended.
NotSupportedException	The XPathNavigator does not support editing.

◆ PrependChild() [2/4]

virtual void System::Xml::XPath::XPathNavigator::PrependChild ( SharedPtr< XmlReader > newChild )

virtual

Creates a new child node at the beginning of the list of child nodes of the current node using the XML contents of the XmlReader object specified.

Parameters

newChild An XmlReader object positioned on the XML data for the new child node.

Exceptions

ArgumentException	The XmlReader object is in an error state or closed.
ArgumentNullException	The XmlReader object parameter is `nullptr`.
InvalidOperationException	The current node the XPathNavigator is positioned on does not allow a new child node to be prepended.
NotSupportedException	The XPathNavigator does not support editing.
XmlException	The XML contents of the XmlReader object parameter is not well-formed.

◆ PrependChild() [3/4]

virtual void System::Xml::XPath::XPathNavigator::PrependChild ( SharedPtr< XPathNavigator > newChild )

virtual

Creates a new child node at the beginning of the list of child nodes of the current node using the nodes in the XPathNavigator object specified.

Parameters

newChild An XPathNavigator object positioned on the node to add as the new child node.

Exceptions

ArgumentNullException	The XPathNavigator object parameter is `nullptr`.
InvalidOperationException	The current node the XPathNavigator is positioned on does not allow a new child node to be prepended.
NotSupportedException	The XPathNavigator does not support editing.

◆ PrependChild() [4/4]

virtual void System::Xml::XPath::XPathNavigator::PrependChild ( String newChild )

virtual

Creates a new child node at the beginning of the list of child nodes of the current node using the XML string specified.

Parameters

newChild The XML data string for the new child node.

Exceptions

ArgumentNullException	The XML string parameter is `nullptr`.
InvalidOperationException	The current node the XPathNavigator is positioned on does not allow a new child node to be prepended.
NotSupportedException	The XPathNavigator does not support editing.
XmlException	The XML string parameter is not well-formed.

◆ PrependChildElement()

virtual void System::Xml::XPath::XPathNavigator::PrependChildElement	(	String	prefix,
		String	localName,
		String	namespaceURI,
		String	value
	)

virtual

Creates a new child element at the beginning of the list of child nodes of the current node using the namespace prefix, local name, and namespace URI specified with the value specified.

Parameters

prefix	The namespace prefix of the new child element (if any).
localName	The local name of the new child element (if any).
namespaceURI	The namespace URI of the new child element (if any). String::Empty and `nullptr` are equivalent.
value	The value of the new child element. If String::Empty or `nullptr` are passed, an empty element is created.

Exceptions

InvalidOperationException	The current node the XPathNavigator is positioned on does not allow a new child node to be prepended.
NotSupportedException	The XPathNavigator does not support editing.

◆ ReadSubtree()

virtual SharedPtr< XmlReader > System::Xml::XPath::XPathNavigator::ReadSubtree ( )

virtual

Returns an XmlReader object that contains the current node and its child nodes.

Returns: An XmlReader object that contains the current node and its child nodes.

Exceptions

InvalidOperationException The XPathNavigator is not positioned on an element node or the root node.

◆ ReplaceRange()

virtual SharedPtr< XmlWriter > System::Xml::XPath::XPathNavigator::ReplaceRange ( SharedPtr< XPathNavigator > lastSiblingToReplace )

virtual

Replaces a range of sibling nodes from the current node to the node specified.

Parameters

lastSiblingToReplace An XPathNavigator positioned on the last sibling node in the range to replace.

Returns: An XmlWriter object used to specify the replacement range.

Exceptions

ArgumentNullException	The XPathNavigator specified is `nullptr`.
NotSupportedException	The XPathNavigator does not support editing.
InvalidOperationException	The last node to replace specified is not a valid sibling node of the current node.

◆ ReplaceSelf() [1/3]

virtual void System::Xml::XPath::XPathNavigator::ReplaceSelf ( SharedPtr< XmlReader > newNode )

virtual

Replaces the current node with the contents of the XmlReader object specified.

Parameters

newNode An XmlReader object positioned on the XML data for the new node.

Exceptions

ArgumentException	The XmlReader object is in an error state or closed.
ArgumentNullException	The XmlReader object parameter is `nullptr`.
InvalidOperationException	The XPathNavigator is not positioned on an element, text, processing instruction, or comment node.
NotSupportedException	The XPathNavigator does not support editing.
XmlException	The XML contents of the XmlReader object parameter is not well-formed.

◆ ReplaceSelf() [2/3]

virtual void System::Xml::XPath::XPathNavigator::ReplaceSelf ( SharedPtr< XPathNavigator > newNode )

virtual

Replaces the current node with the contents of the XPathNavigator object specified.

Parameters

newNode An XPathNavigator object positioned on the new node.

Exceptions

ArgumentNullException	The XPathNavigator object parameter is `nullptr`.
InvalidOperationException	The XPathNavigator is not positioned on an element, text, processing instruction, or comment node.
NotSupportedException	The XPathNavigator does not support editing.
XmlException	The XML contents of the XPathNavigator object parameter is not well-formed.

◆ ReplaceSelf() [3/3]

virtual void System::Xml::XPath::XPathNavigator::ReplaceSelf ( String newNode )

virtual

Replaces the current node with the content of the string specified.

Parameters

newNode The XML data string for the new node.

Exceptions

ArgumentNullException	The XML string parameter is `nullptr`.
InvalidOperationException	The XPathNavigator is not positioned on an element, text, processing instruction, or comment node.
NotSupportedException	The XPathNavigator does not support editing.
XmlException	The XML string parameter is not well-formed.

◆ Select() [1/3]

virtual SharedPtr< XPathNodeIterator > System::Xml::XPath::XPathNavigator::Select ( SharedPtr< XPathExpression > expr )

virtual

Selects a node set using the specified XPathExpression.

Parameters

expr	An XPathExpression object containing the compiled XPath query.

Returns: An XPathNodeIterator that points to the selected node set.

Exceptions

ArgumentException	The XPath expression contains an error or its return type is not a node set.
XPathException	The XPath expression is not valid.

◆ Select() [2/3]

virtual SharedPtr< XPathNodeIterator > System::Xml::XPath::XPathNavigator::Select ( String xpath )

virtual

Selects a node set, using the specified XPath expression.

Parameters

xpath A String representing an XPath expression.

Returns: An XPathNodeIterator pointing to the selected node set.

Exceptions

ArgumentException	The XPath expression contains an error or its return type is not a node set.
XPathException	The XPath expression is not valid.

◆ Select() [3/3]

virtual SharedPtr< XPathNodeIterator > System::Xml::XPath::XPathNavigator::Select	(	String	xpath,
		SharedPtr< IXmlNamespaceResolver >	resolver
	)

virtual

Selects a node set using the specified XPath expression with the IXmlNamespaceResolver object specified to resolve namespace prefixes.

Parameters

xpath	A String representing an XPath expression.
resolver	The IXmlNamespaceResolver object used to resolve namespace prefixes.

Returns: An XPathNodeIterator that points to the selected node set.

Exceptions

ArgumentException	The XPath expression contains an error or its return type is not a node set.
XPathException	The XPath expression is not valid.

◆ SelectAncestors() [1/2]

virtual SharedPtr< XPathNodeIterator > System::Xml::XPath::XPathNavigator::SelectAncestors	(	String	name,
		String	namespaceURI,
		bool	matchSelf
	)

virtual

Selects all the ancestor nodes of the current node that have the specified local name and namespace URI.

Parameters

name	The local name of the ancestor nodes.
namespaceURI	The namespace URI of the ancestor nodes.
matchSelf	To include the context node in the selection, `true`; otherwise, `false`.

Returns: An XPathNodeIterator that contains the selected nodes. The returned nodes are in reverse document order.

Exceptions

ArgumentNullException nullptr cannot be passed as a parameter.

◆ SelectAncestors() [2/2]

virtual SharedPtr< XPathNodeIterator > System::Xml::XPath::XPathNavigator::SelectAncestors	(	XPathNodeType	type,
		bool	matchSelf
	)

virtual

Selects all the ancestor nodes of the current node that have a matching XPathNodeType.

Parameters

type	The XPathNodeType of the ancestor nodes.
matchSelf	To include the context node in the selection, `true`; otherwise, `false`.

Returns: An XPathNodeIterator that contains the selected nodes. The returned nodes are in reverse document order.

◆ SelectChildren() [1/2]

virtual SharedPtr< XPathNodeIterator > System::Xml::XPath::XPathNavigator::SelectChildren	(	String	name,
		String	namespaceURI
	)

virtual

Selects all the child nodes of the current node that have the local name and namespace URI specified.

Parameters

name	The local name of the child nodes.
namespaceURI	The namespace URI of the child nodes.

Returns: An XPathNodeIterator that contains the selected nodes.

Exceptions

ArgumentNullException nullptr cannot be passed as a parameter.

◆ SelectChildren() [2/2]

virtual SharedPtr< XPathNodeIterator > System::Xml::XPath::XPathNavigator::SelectChildren ( XPathNodeType type )

virtual

Selects all the child nodes of the current node that have the matching XPathNodeType.

Parameters

type	The XPathNodeType of the child nodes.

Returns: An XPathNodeIterator that contains the selected nodes.

◆ SelectDescendants() [1/2]

virtual SharedPtr< XPathNodeIterator > System::Xml::XPath::XPathNavigator::SelectDescendants	(	String	name,
		String	namespaceURI,
		bool	matchSelf
	)

virtual

Selects all the descendant nodes of the current node with the local name and namespace URI specified.

Parameters

name	The local name of the descendant nodes.
namespaceURI	The namespace URI of the descendant nodes.
matchSelf	`true` to include the context node in the selection; otherwise, `false`.

Returns: An XPathNodeIterator that contains the selected nodes.

Exceptions

ArgumentNullException nullptr cannot be passed as a parameter.

◆ SelectDescendants() [2/2]

virtual SharedPtr< XPathNodeIterator > System::Xml::XPath::XPathNavigator::SelectDescendants	(	XPathNodeType	type,
		bool	matchSelf
	)

virtual

Selects all the descendant nodes of the current node that have a matching XPathNodeType.

Parameters

type	The XPathNodeType of the descendant nodes.
matchSelf	`true` to include the context node in the selection; otherwise, `false`.

Returns: An XPathNodeIterator that contains the selected nodes.

◆ SelectSingleNode() [1/3]

virtual SharedPtr< XPathNavigator > System::Xml::XPath::XPathNavigator::SelectSingleNode ( SharedPtr< XPathExpression > expression )

virtual

Selects a single node in the XPathNavigator using the specified XPathExpression object.

Parameters

expression An XPathExpression object containing the compiled XPath query.

Returns: An XPathNavigator object that contains the first matching node for the XPath query specified; otherwise nullptr if there are no query results.

Exceptions

ArgumentException	An error was encountered in the XPath query or the return type of the XPath expression is not a node.
XPathException	The XPath query is not valid.

◆ SelectSingleNode() [2/3]

virtual SharedPtr< XPathNavigator > System::Xml::XPath::XPathNavigator::SelectSingleNode ( String xpath )

virtual

Selects a single node in the XPathNavigator using the specified XPath query.

Parameters

xpath A String representing an XPath expression.

Returns: An XPathNavigator object that contains the first matching node for the XPath query specified; otherwise, nullptr if there are no query results.

Exceptions

ArgumentException	An error was encountered in the XPath query or the return type of the XPath expression is not a node.
XPathException	The XPath query is not valid.

◆ SelectSingleNode() [3/3]

virtual SharedPtr< XPathNavigator > System::Xml::XPath::XPathNavigator::SelectSingleNode	(	String	xpath,
		SharedPtr< IXmlNamespaceResolver >	resolver
	)

virtual

Selects a single node in the XPathNavigator object using the specified XPath query with the IXmlNamespaceResolver object specified to resolve namespace prefixes.

Parameters

xpath	A String representing an XPath expression.
resolver	The IXmlNamespaceResolver object used to resolve namespace prefixes in the XPath query.

Returns: An XPathNavigator object that contains the first matching node for the XPath query specified; otherwise nullptr if there are no query results.

Exceptions

ArgumentException	An error was encountered in the XPath query or the return type of the XPath expression is not a node.
XPathException	The XPath query is not valid.

◆ set_InnerXml()

virtual void System::Xml::XPath::XPathNavigator::set_InnerXml ( String value )

virtual

Sets the markup representing the child nodes of the current node.

Parameters

value The value to set.

Exceptions

InvalidOperationException The value cannot be set.

◆ set_OuterXml()

virtual void System::Xml::XPath::XPathNavigator::set_OuterXml ( String value )

virtual

Sets the markup representing the opening and closing tags of the current node and its child nodes.

Parameters

value The value to set.

◆ SetTypedValue()

virtual void System::Xml::XPath::XPathNavigator::SetTypedValue ( SharedPtr< Object > typedValue )

virtual

Sets the typed value of the current node.

Parameters

typedValue The new typed value of the node.

Exceptions

ArgumentException	The XPathNavigator does not support the type of the object specified.
ArgumentNullException	The value specified cannot be `nullptr`.
InvalidOperationException	The XPathNavigator is not positioned on an element or attribute node.
NotSupportedException	The XPathNavigator does not support editing.

◆ SetValue()

virtual void System::Xml::XPath::XPathNavigator::SetValue ( String value )

virtual

Sets the value of the current node.

Parameters

value The new value of the node.

Exceptions

ArgumentNullException	The value parameter is `nullptr`.
InvalidOperationException	The XPathNavigator is positioned on the root node, a namespace node, or the specified value is invalid.
NotSupportedException	The XPathNavigator does not support editing.

◆ ToString()

String System::Xml::XPath::XPathNavigator::ToString ( ) const

overridevirtual

Returns the text value of the current node.

Returns: A string that contains the text value of the current node.

Reimplemented from System::Object.

◆ ValueAs()

SharedPtr< Object > System::Xml::XPath::XPathNavigator::ValueAs	(	const TypeInfo &	returnType,
		SharedPtr< IXmlNamespaceResolver >	nsResolver
	)

overridevirtual

Returns the current node's value as the Type specified, using the IXmlNamespaceResolver object specified to resolve namespace prefixes.

Parameters

returnType	The Type to return the current node's value as.
nsResolver	The IXmlNamespaceResolver object used to resolve namespace prefixes.

Returns: The value of the current node as the Type requested.

Exceptions

FormatException	The current node's value is not in the correct format for the target type.
InvalidCastException	The attempted cast is not valid.

Implements System::Xml::XPath::XPathItem.

◆ WriteSubtree()

virtual void System::Xml::XPath::XPathNavigator::WriteSubtree ( SharedPtr< XmlWriter > writer )

virtual

Streams the current node and its child nodes to the XmlWriter object specified.

Parameters

writer The XmlWriter object to stream to.

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ ~XPathNavigator()

Member Function Documentation

◆ AppendChild() [1/4]

◆ AppendChild() [2/4]

◆ AppendChild() [3/4]

◆ AppendChild() [4/4]

◆ AppendChildElement()

◆ CheckValidity()

◆ Clone()

◆ ComparePosition()

◆ Compile()

◆ CreateAttribute()

◆ CreateAttributes()

◆ CreateNavigator()

◆ DeleteRange()

◆ DeleteSelf()

◆ Evaluate() [1/4]

◆ Evaluate() [2/4]

◆ Evaluate() [3/4]

◆ Evaluate() [4/4]

◆ get_BaseURI()

◆ get_CanEdit()

◆ get_HasAttributes()

◆ get_HasChildren()

◆ get_InnerXml()

◆ get_IsEmptyElement()

◆ get_IsNode()

◆ get_LocalName()

◆ get_Name()

◆ get_NamespaceURI()

◆ get_NameTable()

◆ get_NavigatorComparer()

◆ get_NodeType()

◆ get_OuterXml()

◆ get_Prefix()

◆ get_SchemaInfo()

◆ get_TypedValue()

◆ get_UnderlyingObject()

◆ get_ValueAsBoolean()

◆ get_ValueAsDateTime()

◆ get_ValueAsDouble()

◆ get_ValueAsInt()

◆ get_ValueAsLong()

◆ get_ValueType()

◆ get_XmlLang()

◆ get_XmlType()

◆ GetAttribute()

◆ GetNamespace()

◆ GetNamespacesInScope()

◆ InsertAfter() [1/4]

◆ InsertAfter() [2/4]

◆ InsertAfter() [3/4]

◆ InsertAfter() [4/4]

◆ InsertBefore() [1/4]

◆ InsertBefore() [2/4]

◆ InsertBefore() [3/4]

◆ InsertBefore() [4/4]

◆ InsertElementAfter()

◆ InsertElementBefore()

◆ IsDescendant()

◆ IsSamePosition()

◆ LookupNamespace()

◆ LookupPrefix()

◆ Matches() [1/2]

◆ Matches() [2/2]

◆ MoveTo()

◆ MoveToAttribute()

◆ MoveToChild() [1/2]

◆ MoveToChild() [2/2]

◆ MoveToFirst()

◆ MoveToFirstAttribute()

◆ MoveToFirstChild()