System::Xml::XmlNode Class Referenceabstract

Represents a single node in the XML document. More...

Inherits System::Collections::Generic::IEnumerable< SharedPtr< System::Xml::XmlNode > >, and System::Xml::XPath::IXPathNavigable.

Inherited by System::Xml::XmlAttribute, System::Xml::XmlDocument, System::Xml::XmlDocumentFragment, System::Xml::XmlEntity, System::Xml::XmlLinkedNode, and System::Xml::XmlNotation.

Public Types

using Ptr = SharedPtr< XmlNode >
 An alias for shared pointer to an instance of this class. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< SharedPtr< System::Xml::XmlNode > >
typedef IEnumerator< SharedPtr< System::Xml::XmlNode > > IEnumeratorType
 Enumerator type. More...
 
using ValueType = SharedPtr< System::Xml::XmlNode >
 
using iterator = EnumeratorBasedIterator< SharedPtr< System::Xml::XmlNode >, IEnumerator< SharedPtr< System::Xml::XmlNode > > >
 
using const_iterator = iterator
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

virtual ASPOSECPP_SHARED_API String get_Name ()=0
 Returns the qualified name of the node, when overridden in a derived class. More...
 
virtual ASPOSECPP_SHARED_API String get_Value ()
 Returns the value of the node. More...
 
virtual ASPOSECPP_SHARED_API void set_Value (String value)
 Sets the value of the node. More...
 
virtual ASPOSECPP_SHARED_API XmlNodeType get_NodeType ()=0
 Returns the type of the current node, when overridden in a derived class. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeget_ParentNode () final
 Returns the parent of this node (for nodes that can have parents). More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeListget_ChildNodes ()
 Returns all the child nodes of the node. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeget_PreviousSibling () final
 Returns the node immediately preceding this node. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeget_NextSibling () final
 Returns the node immediately following this node. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlAttributeCollectionget_Attributes () final
 Returns an XmlAttributeCollection containing the attributes of this node. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlDocumentget_OwnerDocument ()
 Returns the XmlDocument to which this node belongs. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeget_FirstChild () final
 Returns the first child of the node. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeget_LastChild () final
 Returns the last child of the node. More...
 
virtual ASPOSECPP_SHARED_API bool get_HasChildNodes ()
 Returns a value indicating whether this node has any child nodes. More...
 
virtual ASPOSECPP_SHARED_API String get_NamespaceURI ()
 Returns the namespace URI of this node. More...
 
virtual ASPOSECPP_SHARED_API String get_Prefix ()
 Returns the namespace prefix of this node. More...
 
virtual ASPOSECPP_SHARED_API void set_Prefix (String value)
 Sets the namespace prefix of this node. More...
 
virtual ASPOSECPP_SHARED_API String get_LocalName ()=0
 Returns the local name of the node, when overridden in a derived class. More...
 
virtual ASPOSECPP_SHARED_API bool get_IsReadOnly ()
 Returns a value indicating whether the node is read-only. More...
 
virtual ASPOSECPP_SHARED_API String get_InnerText ()
 Returns the concatenated values of the node and all its child nodes. More...
 
virtual ASPOSECPP_SHARED_API void set_InnerText (String value)
 Sets the concatenated values of the node and all its child nodes. More...
 
virtual ASPOSECPP_SHARED_API String get_OuterXml ()
 Returns the markup containing this node and all its child nodes. More...
 
virtual ASPOSECPP_SHARED_API String get_InnerXml ()
 Returns the markup representing only the child nodes of this node. More...
 
virtual ASPOSECPP_SHARED_API void set_InnerXml (String value)
 Sets the markup representing only the child nodes of this node. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< Schema::IXmlSchemaInfoget_SchemaInfo ()
 Returns the post schema validation infoset that has been assigned to this node as a result of schema validation. More...
 
virtual ASPOSECPP_SHARED_API String get_BaseURI ()
 Returns the base URI of the current node. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeget_PreviousText ()
 Returns the text node that immediately precedes this node. More...
 
ASPOSECPP_SHARED_API SharedPtr< XPath::XPathNavigatorCreateNavigator () override
 Creates an XPathNavigator for navigating this object. More...
 
ASPOSECPP_SHARED_API SharedPtr< XmlNodeSelectSingleNode (const String &xpath)
 Selects the first XmlNode that matches the XPath expression. More...
 
ASPOSECPP_SHARED_API SharedPtr< XmlNodeSelectSingleNode (const String &xpath, const SharedPtr< XmlNamespaceManager > &nsmgr)
 Selects the first XmlNode that matches the XPath expression. Any prefixes found in the XPath expression are resolved using the supplied XmlNamespaceManager. More...
 
ASPOSECPP_SHARED_API SharedPtr< XmlNodeListSelectNodes (const String &xpath)
 Selects a list of nodes matching the XPath expression. More...
 
ASPOSECPP_SHARED_API SharedPtr< XmlNodeListSelectNodes (const String &xpath, const SharedPtr< XmlNamespaceManager > &nsmgr)
 Selects a list of nodes matching the XPath expression. Any prefixes found in the XPath expression are resolved using the supplied XmlNamespaceManager. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeInsertBefore (SharedPtr< XmlNode > newChild, SharedPtr< XmlNode > refChild)
 Inserts the specified node immediately before the specified reference node. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeInsertAfter (SharedPtr< XmlNode > newChild, SharedPtr< XmlNode > refChild)
 Inserts the specified node immediately after the specified reference node. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeReplaceChild (SharedPtr< XmlNode > newChild, SharedPtr< XmlNode > oldChild)
 Replaces the child node oldChild with newChild node. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeRemoveChild (SharedPtr< XmlNode > oldChild)
 Removes specified child node. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodePrependChild (SharedPtr< XmlNode > newChild)
 Adds the specified node to the beginning of the list of child nodes for this node. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeAppendChild (SharedPtr< XmlNode > newChild)
 Adds the specified node to the end of the list of child nodes, of this node. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeCloneNode (bool deep)=0
 Creates a duplicate of the node, when overridden in a derived class. More...
 
virtual ASPOSECPP_SHARED_API void Normalize ()
 Puts all XmlText nodes in the full depth of the sub-tree underneath this XmlNode into a "normal" form where only markup (that is, tags, comments, processing instructions, CDATA sections, and entity references) separates XmlText nodes, that is, there are no adjacent XmlText nodes. More...
 
virtual ASPOSECPP_SHARED_API bool Supports (String feature, String version)
 Tests if the DOM implementation implements a specific feature. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeClone ()
 Creates a duplicate of this node. More...
 
ASPOSECPP_SHARED_API SharedPtr< Collections::Generic::IEnumerator< SharedPtr< XmlNode > > > GetEnumerator () override
 Returns an enumerator that iterates through the child nodes in the current node. More...
 
virtual ASPOSECPP_SHARED_API void WriteTo (const SharedPtr< XmlWriter > &w)=0
 Saves the current node to the specified XmlWriter, when overridden in a derived class. More...
 
virtual ASPOSECPP_SHARED_API void WriteContentTo (const SharedPtr< XmlWriter > &w)=0
 Saves all the child nodes of the node to the specified XmlWriter, when overridden in a derived class. More...
 
virtual ASPOSECPP_SHARED_API void RemoveAll ()
 Removes all the child nodes and/or attributes of the current node. More...
 
virtual ASPOSECPP_SHARED_API String GetNamespaceOfPrefix (String prefix)
 Looks up the closest xmlns declaration for the given prefix that is in scope for the current node and returns the namespace URI in the declaration. More...
 
virtual ASPOSECPP_SHARED_API String GetPrefixOfNamespace (String namespaceURI)
 Looks up the closest xmlns declaration for the given namespace URI that is in scope for the current node and returns the prefix defined in that declaration. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlElementidx_get (String name)
 Returns the first child element with the specified XmlNode::get_Name. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlElementidx_get (String localname, String ns)
 Returns the first child element with the specified XmlNode::get_LocalName and XmlNode::get_NamespaceURI values. More...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< SharedPtr< System::Xml::XmlNode > >
SharedPtr< System::Xml::XmlNodeLINQ_ElementAt (int index)
 Returns the element at a specified index in a sequence. More...
 
SharedPtr< System::Xml::XmlNodeLINQ_First ()
 Returns the first element of a sequence. More...
 
SharedPtr< System::Xml::XmlNodeLINQ_First (const Func< SharedPtr< System::Xml::XmlNode >, bool > &predicate)
 Returns the first element of a sequence that satisfy the specified condition. More...
 
SharedPtr< System::Xml::XmlNodeLINQ_FirstOrDefault ()
 Returns the first element of a sequence, or a default value if the sequence is empty. More...
 
SharedPtr< System::Xml::XmlNodeLINQ_FirstOrDefault (std::function< bool(SharedPtr< System::Xml::XmlNode >)> predicate)
 Returns the first element of the sequence that satisfies a condition or a default value if no such element is found. More...
 
SharedPtr< System::Xml::XmlNodeLINQ_Last ()
 Returns the last element of a sequence. More...
 
SharedPtr< System::Xml::XmlNodeLINQ_LastOrDefault ()
 Returns the last element of a sequence, or a default value if the sequence is empty. More...
 
SharedPtr< List< SharedPtr< System::Xml::XmlNode > > > LINQ_ToList ()
 Creates a List<T> from a sequence. More...
 
int LINQ_Count ()
 Returns the number of elements in the sequence (calculated via direct counting). More...
 
int LINQ_Count (const Func< SharedPtr< System::Xml::XmlNode >, bool > &predicate)
 Returns the number of elements in the sequence that satisfy the specified condition. More...
 
System::ArrayPtr< SharedPtr< System::Xml::XmlNode > > LINQ_ToArray ()
 Creates an array from a sequence. More...
 
bool LINQ_All (std::function< bool(SharedPtr< System::Xml::XmlNode >)> predicate)
 Determines whether all elements of a sequence satisfy a condition. More...
 
bool LINQ_Any ()
 Determines whether a sequence contains any elements. More...
 
bool LINQ_Any (std::function< bool(SharedPtr< System::Xml::XmlNode >)> predicate)
 Determines whether any element of a sequence exists or satisfies a condition. More...
 
SharedPtr< IEnumerable< SharedPtr< System::Xml::XmlNode > > > LINQ_Where (std::function< bool(SharedPtr< System::Xml::XmlNode >)> predicate)
 Filters a sequence based on the specified predicate. More...
 
bool LINQ_Contains (SharedPtr< System::Xml::XmlNode > value)
 Determines if a sequence contains a specified value. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 Casts the elements to the specified type. More...
 
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
SharedPtr< IEnumerable< SharedPtr< System::Xml::XmlNode > > > LINQ_OrderBy (const Func< SharedPtr< System::Xml::XmlNode >, Key > &keySelector)
 Sorts the elements of a sequence in ascending order according to the key values selected by keySelector. More...
 
SharedPtr< IEnumerable< Source > > LINQ_OrderBy (const Func< Source, Key > &keySelector)
 
SharedPtr< IEnumerable< SharedPtr< System::Xml::XmlNode > > > LINQ_OrderByDescending (const Func< SharedPtr< System::Xml::XmlNode >, Key > &keySelector)
 Sorts the elements of a sequence in descending order according to the key values selected by keySelector. More...
 
SharedPtr< IEnumerable< Source > > LINQ_OrderByDescending (const Func< Source, Key > &keySelector)
 
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 Filters the elements of the sequence based on the specified type. More...
 
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< SharedPtr< System::Xml::XmlNode >, ResultType > &selector)
 Transforms elements of a sequence. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< SharedPtr< System::Xml::XmlNode >, int32_t, ResultType > &selector)
 Transforms each element of a sequence into a new form by incorporating the element's index. More...
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, int32_t, Result > &selector)
 
SharedPtr< IEnumerable< SharedPtr< System::Xml::XmlNode > > > LINQ_Concat (SharedPtr< IEnumerable< SharedPtr< System::Xml::XmlNode > >> sequence)
 Concatenates two sequences. More...
 
System::SharedPtr< IEnumerable< System::SharedPtr< System::Linq::IGrouping< Key, SharedPtr< System::Xml::XmlNode > > > > > LINQ_GroupBy (System::Func< SharedPtr< System::Xml::XmlNode >, Key > keyPredicate)
 Groups the elements of a sequence. More...
 
SharedPtr< IEnumerable< SharedPtr< System::Linq::IGrouping< Key, Source > > > > LINQ_GroupBy (System::Func< Source, Key > keyPredicate)
 
SharedPtr< IEnumerable< ResultType > > LINQ_SelectMany (const Func< SharedPtr< System::Xml::XmlNode >, SharedPtr< IEnumerable< ResultType >>> &selector)
 Projects each element of a sequence and combines the resulting sequences into one sequence. More...
 
SharedPtr< IEnumerable< Result > > LINQ_SelectMany (const Func< Source, SharedPtr< IEnumerable< Result >>> &selector)
 
iterator begin () noexcept
 Gets iterator pointing to the first element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator begin () const noexcept
 Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection. More...
 
iterator end () noexcept
 Gets iterator pointing right after the last element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator end () const noexcept
 Gets iterator pointing right after the last element (if any) of the const-qualified instance of the collection. More...
 
const_iterator cbegin () const noexcept
 Gets iterator pointing to the first const-qualified element (if any) of the collection. More...
 
const_iterator cend () const noexcept
 Gets iterator pointing right after the last const-qualified element (if any) of the collection. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 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...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API 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 ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. 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...
 
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...
 

Protected Member Functions

virtual ASPOSECPP_SHARED_API ~XmlNode ()
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< SharedPtr< System::Xml::XmlNode > >
 ~IEnumerable () override
 Destructor. More...
 

Additional Inherited Members

- 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 TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

Represents a single node in the XML document.

Member Typedef Documentation

◆ Ptr

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

Constructor & Destructor Documentation

◆ ~XmlNode()

virtual ASPOSECPP_SHARED_API System::Xml::XmlNode::~XmlNode ( )
protectedvirtual

Member Function Documentation

◆ AppendChild()

virtual ASPOSECPP_SHARED_API SharedPtr<XmlNode> System::Xml::XmlNode::AppendChild ( SharedPtr< XmlNode newChild)
virtual

Adds the specified node to the end of the list of child nodes, of this node.

Parameters
newChildThe node to add. All the contents of the node to be added are moved into the specified location.
Returns
The node added.
Exceptions
InvalidOperationExceptionThis node is of a type that does not allow child nodes of the type of the newChild node. The newChild is an ancestor of this node.
ArgumentExceptionThe newChild was created from a different document than the one that created this node. This node is read-only.

Reimplemented in System::Xml::XmlAttribute.

◆ Clone()

virtual ASPOSECPP_SHARED_API SharedPtr<XmlNode> System::Xml::XmlNode::Clone ( )
virtual

Creates a duplicate of this node.

Returns
The cloned node.

◆ CloneNode()

virtual ASPOSECPP_SHARED_API SharedPtr<XmlNode> System::Xml::XmlNode::CloneNode ( bool  deep)
pure virtual

Creates a duplicate of the node, when overridden in a derived class.

Parameters
deeptrue to recursively clone the subtree under the specified node; false to clone only the node itself.
Returns
The cloned node.
Exceptions
InvalidOperationExceptionCalling this method on a node type that cannot be cloned.

Implemented in System::Xml::XmlDocument, System::Xml::XmlElement, System::Xml::XmlAttribute, System::Xml::XmlDeclaration, System::Xml::XmlEntity, System::Xml::XmlProcessingInstruction, System::Xml::XmlDocumentType, System::Xml::XmlNotation, System::Xml::XmlEntityReference, System::Xml::XmlSignificantWhitespace, System::Xml::XmlWhitespace, System::Xml::XmlText, System::Xml::XmlDocumentFragment, System::Xml::XmlCDataSection, and System::Xml::XmlComment.

◆ CreateNavigator()

ASPOSECPP_SHARED_API SharedPtr<XPath::XPathNavigator> System::Xml::XmlNode::CreateNavigator ( )
overridevirtual

Creates an XPathNavigator for navigating this object.

Returns
An XPathNavigator object used to navigate the node. The XPathNavigator is positioned on the node from which the method was called. It is not positioned on the root of the document.

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

◆ get_Attributes()

virtual ASPOSECPP_SHARED_API SharedPtr<XmlAttributeCollection> System::Xml::XmlNode::get_Attributes ( )
finalvirtual

Returns an XmlAttributeCollection containing the attributes of this node.

Returns
An XmlAttributeCollection containing the attributes of the node. If the node is of type XmlNodeType::Element, the attributes of the node are returned. Otherwise, this method returns nullptr.

◆ get_BaseURI()

virtual ASPOSECPP_SHARED_API String System::Xml::XmlNode::get_BaseURI ( )
virtual

Returns the base URI of the current node.

Returns
The location from which the node was loaded or String::Empty if the node has no base URI.

Reimplemented in System::Xml::XmlDocument, System::Xml::XmlAttribute, System::Xml::XmlEntity, and System::Xml::XmlEntityReference.

◆ get_ChildNodes()

virtual ASPOSECPP_SHARED_API SharedPtr<XmlNodeList> System::Xml::XmlNode::get_ChildNodes ( )
virtual

Returns all the child nodes of the node.

Returns
An object that contains all the child nodes of the node. If there are no child nodes, this method returns an empty XmlNodeList.

◆ get_FirstChild()

virtual ASPOSECPP_SHARED_API SharedPtr<XmlNode> System::Xml::XmlNode::get_FirstChild ( )
finalvirtual

Returns the first child of the node.

Returns
The first child of the node. If there is no such node, nullptr is returned.

◆ get_HasChildNodes()

virtual ASPOSECPP_SHARED_API bool System::Xml::XmlNode::get_HasChildNodes ( )
virtual

Returns a value indicating whether this node has any child nodes.

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

◆ get_InnerText()

virtual ASPOSECPP_SHARED_API String System::Xml::XmlNode::get_InnerText ( )
virtual

Returns the concatenated values of the node and all its child nodes.

Returns
The concatenated values of the node and all its child nodes.

Reimplemented in System::Xml::XmlElement, System::Xml::XmlDeclaration, System::Xml::XmlProcessingInstruction, System::Xml::XmlCharacterData, and System::Xml::XmlEntity.

◆ get_InnerXml()

virtual ASPOSECPP_SHARED_API String System::Xml::XmlNode::get_InnerXml ( )
virtual

Returns the markup representing only the child nodes of this node.

Returns
The markup of the child nodes of this node, not including default attributes.
Exceptions
InvalidOperationExceptionSetting this value on a node that cannot have child nodes.
XmlExceptionThe XML specified when setting this value is not well-formed.

Reimplemented in System::Xml::XmlDocument, System::Xml::XmlElement, System::Xml::XmlEntity, System::Xml::XmlNotation, and System::Xml::XmlDocumentFragment.

◆ get_IsReadOnly()

virtual ASPOSECPP_SHARED_API bool System::Xml::XmlNode::get_IsReadOnly ( )
virtual

Returns a value indicating whether the node is read-only.

Returns
true if the node is read-only; otherwise, false.

Reimplemented in System::Xml::XmlDocument, System::Xml::XmlEntityReference, System::Xml::XmlDocumentType, System::Xml::XmlNotation, and System::Xml::XmlEntity.

◆ get_LastChild()

virtual ASPOSECPP_SHARED_API SharedPtr<XmlNode> System::Xml::XmlNode::get_LastChild ( )
finalvirtual

Returns the last child of the node.

Returns
The last child of the node. If there is no such node, nullptr is returned.

◆ get_LocalName()

virtual ASPOSECPP_SHARED_API String System::Xml::XmlNode::get_LocalName ( )
pure virtual

Returns the local name of the node, when overridden in a derived class.

Returns
The name of the node with the prefix removed. For example, LocalName is book for the element <bk:book>.

The name returned is dependent on the XmlNode::get_NodeType of the node:

Type Name
Attribute The local name of the attribute.
CDATA #cdata-section
Comment #comment
Document #document
DocumentFragment #document-fragment
DocumentType The document type name.
Element The local name of the element.
Entity The name of the entity.
EntityReference The name of the entity referenced.
Notation The notation name.
ProcessingInstruction The target of the processing instruction.
Text #text
Whitespace #whitespace
SignificantWhitespace #significant-whitespace
XmlDeclaration #xml-declaration

Implemented in System::Xml::XmlDocument, System::Xml::XmlDeclaration, System::Xml::XmlElement, System::Xml::XmlAttribute, System::Xml::XmlDocumentType, System::Xml::XmlSignificantWhitespace, System::Xml::XmlText, System::Xml::XmlCDataSection, System::Xml::XmlComment, System::Xml::XmlProcessingInstruction, System::Xml::XmlWhitespace, System::Xml::XmlDocumentFragment, System::Xml::XmlEntity, System::Xml::XmlEntityReference, and System::Xml::XmlNotation.

◆ get_Name()

virtual ASPOSECPP_SHARED_API String System::Xml::XmlNode::get_Name ( )
pure virtual

Returns the qualified name of the node, when overridden in a derived class.

Returns
The qualified name of the node.

The name returned is dependent on the XmlNode::get_NodeType of the node:

Type Name
Attribute The qualified name of the attribute.
CDATA #cdata-section
Comment #comment
Document #document
DocumentFragment #document-fragment
DocumentType The document type name.
Element The qualified name of the element.
Entity The name of the entity.
EntityReference The name of the entity referenced.
Notation The notation name.
ProcessingInstruction The target of the processing instruction.
Text #text
Whitespace #whitespace
SignificantWhitespace #significant-whitespace
XmlDeclaration #xml-declaration

Implemented in System::Xml::XmlDocument, System::Xml::XmlDeclaration, System::Xml::XmlElement, System::Xml::XmlAttribute, System::Xml::XmlDocumentType, System::Xml::XmlSignificantWhitespace, System::Xml::XmlText, System::Xml::XmlCDataSection, System::Xml::XmlComment, System::Xml::XmlProcessingInstruction, System::Xml::XmlWhitespace, System::Xml::XmlDocumentFragment, System::Xml::XmlEntity, System::Xml::XmlEntityReference, and System::Xml::XmlNotation.

◆ get_NamespaceURI()

virtual ASPOSECPP_SHARED_API String System::Xml::XmlNode::get_NamespaceURI ( )
virtual

Returns the namespace URI of this node.

Returns
The namespace URI of this node. If there is no namespace URI, this method returns String::Empty.

Reimplemented in System::Xml::XmlElement, and System::Xml::XmlAttribute.

◆ get_NextSibling()

virtual ASPOSECPP_SHARED_API SharedPtr<XmlNode> System::Xml::XmlNode::get_NextSibling ( )
finalvirtual

Returns the node immediately following this node.

Returns
The next XmlNode. If there is no next node, nullptr is returned.

◆ get_NodeType()

◆ get_OuterXml()

virtual ASPOSECPP_SHARED_API String System::Xml::XmlNode::get_OuterXml ( )
virtual

Returns the markup containing this node and all its child nodes.

Returns
The markup containing this node and all its child nodes, not including default attributes.

Reimplemented in System::Xml::XmlEntity, and System::Xml::XmlNotation.

◆ get_OwnerDocument()

virtual ASPOSECPP_SHARED_API SharedPtr<XmlDocument> System::Xml::XmlNode::get_OwnerDocument ( )
virtual

Returns the XmlDocument to which this node belongs.

Returns
The XmlDocument to which this node belongs. If the node is an XmlDocument (NodeType equals XmlNodeType::Document), this method returns nullptr.

Reimplemented in System::Xml::XmlDocument, System::Xml::XmlElement, System::Xml::XmlAttribute, and System::Xml::XmlDocumentFragment.

◆ get_ParentNode()

virtual ASPOSECPP_SHARED_API SharedPtr<XmlNode> System::Xml::XmlNode::get_ParentNode ( )
finalvirtual

Returns the parent of this node (for nodes that can have parents).

Returns
The XmlNode that is the parent of the current node.

If a node has just been created and not yet added to the tree, or if it has been removed from the tree, the parent is nullptr. For all other nodes, the value returned depends on the XmlNode::get_NodeType of the node. The following table describes the possible return values for the get_NodeType method.

NodeType Return Value of ParentNode
Attribute, Document, DocumentFragment, Entity, Notation Returns nullptr; these nodes do not have parents.
CDATA Returns the element or entity reference containing the CDATA section.
Comment Returns the element, entity reference, document type, or document containing the comment.
DocumentType Returns the document node.
Element Returns the parent node of the element. If the element is the root node in the tree, the parent is the document node.
EntityReference Returns the element, attribute, or entity reference containing the entity reference.
ProcessingInstruction Returns the document, element, document type, or entity reference containing the processing instruction.
Text Returns the parent element, attribute, or entity reference containing the text node.

◆ get_Prefix()

virtual ASPOSECPP_SHARED_API String System::Xml::XmlNode::get_Prefix ( )
virtual

Returns the namespace prefix of this node.

Returns
The namespace prefix of this node. For example, Prefix is bk for the element <bk:book>. If there is no prefix, this method returns String::Empty.

Reimplemented in System::Xml::XmlElement, and System::Xml::XmlAttribute.

◆ get_PreviousSibling()

virtual ASPOSECPP_SHARED_API SharedPtr<XmlNode> System::Xml::XmlNode::get_PreviousSibling ( )
finalvirtual

Returns the node immediately preceding this node.

Returns
The preceding XmlNode. If there is no preceding node, nullptr is returned.

◆ get_PreviousText()

virtual ASPOSECPP_SHARED_API SharedPtr<XmlNode> System::Xml::XmlNode::get_PreviousText ( )
virtual

Returns the text node that immediately precedes this node.

Returns
Returns XmlNode.

Reimplemented in System::Xml::XmlSignificantWhitespace, System::Xml::XmlText, System::Xml::XmlWhitespace, and System::Xml::XmlCDataSection.

◆ get_SchemaInfo()

virtual ASPOSECPP_SHARED_API SharedPtr<Schema::IXmlSchemaInfo> System::Xml::XmlNode::get_SchemaInfo ( )
virtual

Returns the post schema validation infoset that has been assigned to this node as a result of schema validation.

Returns
An IXmlSchemaInfo object containing the post schema validation infoset of this node.

Reimplemented in System::Xml::XmlDocument, System::Xml::XmlElement, and System::Xml::XmlAttribute.

◆ get_Value()

virtual ASPOSECPP_SHARED_API String System::Xml::XmlNode::get_Value ( )
virtual

Returns the value of the node.

Returns
The value returned depends on the XmlNode::get_NodeType of the node:
Type Value
Attribute The value of the attribute.
CDATASection The content of the CDATA Section.
Comment The content of the comment.
Document nullptr.
DocumentFragment nullptr.
DocumentType nullptr.
Element nullptr. You can use the XmlElement::InnerText or XmlElement::get_InnerXml values to access the value of the element node.
Entity nullptr.
EntityReference nullptr.
Notation nullptr.
ProcessingInstruction The entire content excluding the target.
Text The content of the text node.
SignificantWhitespace The white space characters. White space can consist of one or more space characters, carriage returns, line feeds, or tabs.
Whitespace The white space characters. White space can consist of one or more space characters, carriage returns, line feeds, or tabs.
XmlDeclaration The content of the declaration (that is, everything between <?xml and ?>).

Reimplemented in System::Xml::XmlAttribute, System::Xml::XmlDeclaration, System::Xml::XmlSignificantWhitespace, System::Xml::XmlText, System::Xml::XmlWhitespace, System::Xml::XmlProcessingInstruction, System::Xml::XmlCharacterData, and System::Xml::XmlEntityReference.

◆ GetEnumerator()

ASPOSECPP_SHARED_API SharedPtr<Collections::Generic::IEnumerator<SharedPtr<XmlNode> > > System::Xml::XmlNode::GetEnumerator ( )
overridevirtual

Returns an enumerator that iterates through the child nodes in the current node.

Returns
An Collections::IEnumerator object that can be used to iterate through the child nodes in the current node.

Implements System::Collections::Generic::IEnumerable< SharedPtr< System::Xml::XmlNode > >.

◆ GetNamespaceOfPrefix()

virtual ASPOSECPP_SHARED_API String System::Xml::XmlNode::GetNamespaceOfPrefix ( String  prefix)
virtual

Looks up the closest xmlns declaration for the given prefix that is in scope for the current node and returns the namespace URI in the declaration.

Parameters
prefixThe prefix whose namespace URI you want to find.
Returns
The namespace URI of the specified prefix.

◆ GetPrefixOfNamespace()

virtual ASPOSECPP_SHARED_API String System::Xml::XmlNode::GetPrefixOfNamespace ( String  namespaceURI)
virtual

Looks up the closest xmlns declaration for the given namespace URI that is in scope for the current node and returns the prefix defined in that declaration.

Parameters
namespaceURIThe namespace URI whose prefix you want to find.
Returns
The prefix for the specified namespace URI.

◆ idx_get() [1/2]

virtual ASPOSECPP_SHARED_API SharedPtr<XmlElement> System::Xml::XmlNode::idx_get ( String  name)
virtual

Returns the first child element with the specified XmlNode::get_Name.

Parameters
nameThe qualified name of the element to retrieve.
Returns
The first XmlElement that matches the specified name. It returns nullptr if there is no match.

◆ idx_get() [2/2]

virtual ASPOSECPP_SHARED_API SharedPtr<XmlElement> System::Xml::XmlNode::idx_get ( String  localname,
String  ns 
)
virtual

Returns the first child element with the specified XmlNode::get_LocalName and XmlNode::get_NamespaceURI values.

Parameters
localnameThe local name of the element.
nsThe namespace URI of the element.
Returns
The first XmlElement with the matching localname and ns. It returns nullptr if there is no match.

◆ InsertAfter()

virtual ASPOSECPP_SHARED_API SharedPtr<XmlNode> System::Xml::XmlNode::InsertAfter ( SharedPtr< XmlNode newChild,
SharedPtr< XmlNode refChild 
)
virtual

Inserts the specified node immediately after the specified reference node.

Parameters
newChildThe node to insert.
refChildThe reference node. newChild is placed after refChild.
Returns
The node being inserted.
Exceptions
InvalidOperationExceptionThis node is of a type that does not allow child nodes of the type of the newChild node. The newChild is an ancestor of this node.
ArgumentExceptionThe newChild was created from a different document than the one that created this node. The refChild is not a child of this node. This node is read-only.

Reimplemented in System::Xml::XmlAttribute.

◆ InsertBefore()

virtual ASPOSECPP_SHARED_API SharedPtr<XmlNode> System::Xml::XmlNode::InsertBefore ( SharedPtr< XmlNode newChild,
SharedPtr< XmlNode refChild 
)
virtual

Inserts the specified node immediately before the specified reference node.

Parameters
newChildThe node to insert.
refChildThe reference node. newChild is placed before this node.
Returns
The node being inserted.
Exceptions
InvalidOperationExceptionThe current node is of a type that does not allow child nodes of the type of the newChild node. The newChild is an ancestor of this node.
ArgumentExceptionThe newChild was created from a different document than the one that created this node. The refChild is not a child of this node. This node is read-only.

Reimplemented in System::Xml::XmlAttribute.

◆ Normalize()

virtual ASPOSECPP_SHARED_API void System::Xml::XmlNode::Normalize ( )
virtual

Puts all XmlText nodes in the full depth of the sub-tree underneath this XmlNode into a "normal" form where only markup (that is, tags, comments, processing instructions, CDATA sections, and entity references) separates XmlText nodes, that is, there are no adjacent XmlText nodes.

◆ PrependChild()

virtual ASPOSECPP_SHARED_API SharedPtr<XmlNode> System::Xml::XmlNode::PrependChild ( SharedPtr< XmlNode newChild)
virtual

Adds the specified node to the beginning of the list of child nodes for this node.

Parameters
newChildThe node to add. All the contents of the node to be added are moved into the specified location.
Returns
The node added.
Exceptions
InvalidOperationExceptionThis node is of a type that does not allow child nodes of the type of the newChild node. The newChild is an ancestor of this node.
ArgumentExceptionThe newChild was created from a different document than the one that created this node. This node is read-only.

Reimplemented in System::Xml::XmlAttribute.

◆ RemoveAll()

virtual ASPOSECPP_SHARED_API void System::Xml::XmlNode::RemoveAll ( )
virtual

Removes all the child nodes and/or attributes of the current node.

Reimplemented in System::Xml::XmlElement.

◆ RemoveChild()

virtual ASPOSECPP_SHARED_API SharedPtr<XmlNode> System::Xml::XmlNode::RemoveChild ( SharedPtr< XmlNode oldChild)
virtual

Removes specified child node.

Parameters
oldChildThe node being removed.
Returns
The node removed.
Exceptions
ArgumentExceptionThe oldChild is not a child of this node. Or this node is read-only.

Reimplemented in System::Xml::XmlAttribute.

◆ ReplaceChild()

virtual ASPOSECPP_SHARED_API SharedPtr<XmlNode> System::Xml::XmlNode::ReplaceChild ( SharedPtr< XmlNode newChild,
SharedPtr< XmlNode oldChild 
)
virtual

Replaces the child node oldChild with newChild node.

Parameters
newChildThe new node to put in the child list.
oldChildThe node being replaced in the list.
Returns
The node replaced.
Exceptions
InvalidOperationExceptionThis node is of a type that does not allow child nodes of the type of the newChild node. The newChild is an ancestor of this node.
ArgumentExceptionThe newChild was created from a different document than the one that created this node. This node is read-only. The oldChild is not a child of this node.

Reimplemented in System::Xml::XmlAttribute.

◆ SelectNodes() [1/2]

ASPOSECPP_SHARED_API SharedPtr<XmlNodeList> System::Xml::XmlNode::SelectNodes ( const String xpath)

Selects a list of nodes matching the XPath expression.

Parameters
xpathThe XPath expression.
Returns
An XmlNodeList containing a collection of nodes matching the XPath query.
Exceptions
XPathExceptionThe XPath expression contains a prefix.

◆ SelectNodes() [2/2]

ASPOSECPP_SHARED_API SharedPtr<XmlNodeList> System::Xml::XmlNode::SelectNodes ( const String xpath,
const SharedPtr< XmlNamespaceManager > &  nsmgr 
)

Selects a list of nodes matching the XPath expression. Any prefixes found in the XPath expression are resolved using the supplied XmlNamespaceManager.

Parameters
xpathThe XPath expression.
nsmgrAn XmlNamespaceManager to use for resolving namespaces for prefixes in the XPath expression.
Returns
An XmlNodeList containing a collection of nodes matching the XPath query.
Exceptions
XPathExceptionThe XPath expression contains a prefix which is not defined in the XmlNamespaceManager.

◆ SelectSingleNode() [1/2]

ASPOSECPP_SHARED_API SharedPtr<XmlNode> System::Xml::XmlNode::SelectSingleNode ( const String xpath)

Selects the first XmlNode that matches the XPath expression.

Parameters
xpathThe XPath expression.
Returns
The first XmlNode that matches the XPath query or nullptr if no matching node is found.
Exceptions
XPathExceptionThe XPath expression contains a prefix.

◆ SelectSingleNode() [2/2]

ASPOSECPP_SHARED_API SharedPtr<XmlNode> System::Xml::XmlNode::SelectSingleNode ( const String xpath,
const SharedPtr< XmlNamespaceManager > &  nsmgr 
)

Selects the first XmlNode that matches the XPath expression. Any prefixes found in the XPath expression are resolved using the supplied XmlNamespaceManager.

Parameters
xpathThe XPath expression.
nsmgrAn XmlNamespaceManager to use for resolving namespaces for prefixes in the XPath expression.
Returns
The first XmlNode that matches the XPath query or nullptr if no matching node is found.
Exceptions
XPathExceptionThe XPath expression contains a prefix which is not defined in the XmlNamespaceManager.

◆ set_InnerText()

virtual ASPOSECPP_SHARED_API void System::Xml::XmlNode::set_InnerText ( String  value)
virtual

Sets the concatenated values of the node and all its child nodes.

Parameters
valueThe value to set.

Reimplemented in System::Xml::XmlDocument, System::Xml::XmlElement, System::Xml::XmlAttribute, System::Xml::XmlDeclaration, System::Xml::XmlProcessingInstruction, System::Xml::XmlCharacterData, and System::Xml::XmlEntity.

◆ set_InnerXml()

virtual ASPOSECPP_SHARED_API void System::Xml::XmlNode::set_InnerXml ( String  value)
virtual

Sets the markup representing only the child nodes of this node.

Parameters
valueThe value to set.
Exceptions
InvalidOperationExceptionSetting this value on a node that cannot have child nodes.
XmlExceptionThe XML specified when setting this value is not well-formed.

Reimplemented in System::Xml::XmlDocument, System::Xml::XmlAttribute, System::Xml::XmlElement, System::Xml::XmlEntity, System::Xml::XmlNotation, and System::Xml::XmlDocumentFragment.

◆ set_Prefix()

virtual ASPOSECPP_SHARED_API void System::Xml::XmlNode::set_Prefix ( String  value)
virtual

Sets the namespace prefix of this node.

Parameters
valueThe value to set.
Exceptions
ArgumentExceptionThis node is read-only.
XmlExceptionThe specified prefix contains an invalid character. The specified prefix is malformed. The specified prefix is "xml" and the namespaceURI of this node is different from "http://www.w3.org/XML/1998/namespace". This node is an attribute and the specified prefix is "xmlns" and the namespaceURI of this node is different from "http://www.w3.org/2000/xmlns/ ". This node is an attribute and the qualifiedName of this node is "xmlns".

Reimplemented in System::Xml::XmlElement, and System::Xml::XmlAttribute.

◆ set_Value()

virtual ASPOSECPP_SHARED_API void System::Xml::XmlNode::set_Value ( String  value)
virtual

Sets the value of the node.

Parameters
valueThe value to set.
Exceptions
ArgumentExceptionSetting the value of a node that is read-only.
InvalidOperationExceptionSetting the value of a node that is not supposed to have a value (for example, an Element node).

Reimplemented in System::Xml::XmlAttribute, System::Xml::XmlDeclaration, System::Xml::XmlSignificantWhitespace, System::Xml::XmlText, System::Xml::XmlWhitespace, System::Xml::XmlProcessingInstruction, System::Xml::XmlEntityReference, and System::Xml::XmlCharacterData.

◆ Supports()

virtual ASPOSECPP_SHARED_API bool System::Xml::XmlNode::Supports ( String  feature,
String  version 
)
virtual

Tests if the DOM implementation implements a specific feature.

Parameters
featureThe package name of the feature to test. This name is not case-sensitive.
versionThe version number of the package name to test. If the version is not specified (null), supporting any version of the feature causes the method to return true.
Returns
true if the feature is implemented in the specified version; otherwise, false.

The following table describes the combinations that return true.

Feature Version
XML 1.0
XML 2.0

◆ WriteContentTo()

◆ WriteTo()