CodePorting.Translator.Cs2Cpp.Framework

Represents an XML document. You can use this class to load, validate, edit, add, and position XML in a document. More...

#include <xml_document.h>

Inherits System::Xml::XmlNode.

Public Types

using Ptr = SharedPtr< XmlDocument >
 An alias for shared pointer to an instance of this class. More...
 
- Public Types inherited from System::Xml::XmlNode
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 = System::Details::VirtualizedIterator< SharedPtr< System::Xml::XmlNode > >
 Iterator type. More...
 
using const_iterator = System::Details::VirtualizedConstIterator< SharedPtr< System::Xml::XmlNode > >
 Const iterator type. More...
 
using virtualized_iterator = System::Details::VirtualizedIteratorBase< SharedPtr< System::Xml::XmlNode > >
 Inner iterator base type. More...
 
using virtualized_iterator_element = SharedPtr< System::Xml::XmlNode >
 Inner iterator element type. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

XmlNodeType get_NodeType () override
 Returns the type of the current node. More...
 
virtual SharedPtr< XmlDocumentTypeget_DocumentType ()
 Returns the node containing the DOCTYPE declaration. More...
 
SharedPtr< XmlImplementationget_Implementation ()
 Returns the XmlImplementation object for the current document. More...
 
String get_Name () override
 Returns the qualified name of the node. More...
 
String get_LocalName () override
 Returns the local name of the node. More...
 
SharedPtr< XmlElementget_DocumentElement ()
 Returns the root XmlElement for the document. More...
 
SharedPtr< XmlDocumentget_OwnerDocument () override
 Returns the XmlDocument to which the current node belongs. More...
 
SharedPtr< Schema::XmlSchemaSetget_Schemas ()
 Returns the XmlSchemaSet object associated with this XmlDocument. More...
 
void set_Schemas (const SharedPtr< Schema::XmlSchemaSet > &value)
 Sets the XmlSchemaSet object associated with this XmlDocument. More...
 
virtual void set_XmlResolver (SharedPtr< System::Xml::XmlResolver > value)
 Sets the XmlResolver to use for resolving external resources. More...
 
SharedPtr< XmlNameTableget_NameTable ()
 Returns the XmlNameTable associated with this implementation. More...
 
bool get_PreserveWhitespace ()
 Returns a value indicating whether to preserve white space in element content. More...
 
void set_PreserveWhitespace (bool value)
 Sets a value indicating whether to preserve white space in element content. More...
 
bool get_IsReadOnly () override
 Returns a value indicating whether the current node is read-only. More...
 
void set_InnerText (String value) override
 Throws an InvalidOperationException in all cases. More...
 
String get_InnerXml () override
 Returns the markup representing the children of the current node. More...
 
void set_InnerXml (String value) override
 Sets the markup representing the children of the current node. More...
 
SharedPtr< Schema::IXmlSchemaInfoget_SchemaInfo () override
 Returns the Post-Schema-Validation-Infoset (PSVI) of the node. More...
 
String get_BaseURI () override
 Returns the base URI of the current node. More...
 
 XmlDocument ()
 Initializes a new instance of the XmlDocument class. More...
 
 XmlDocument (const SharedPtr< XmlNameTable > &nt)
 Initializes a new instance of the XmlDocument class with the specified XmlNameTable. More...
 
SharedPtr< XmlNodeCloneNode (bool deep) override
 Creates a duplicate of this node. More...
 
SharedPtr< XmlAttributeCreateAttribute (const String &name)
 Creates an XmlAttribute with the specified name. More...
 
virtual SharedPtr< XmlCDataSectionCreateCDataSection (const String &data)
 Creates an XmlCDataSection containing the specified data. More...
 
virtual SharedPtr< XmlCommentCreateComment (const String &data)
 Creates an XmlComment containing the specified data. More...
 
virtual SharedPtr< XmlDocumentTypeCreateDocumentType (const String &name, const String &publicId, const String &systemId, const String &internalSubset)
 Returns a new XmlDocumentType object. More...
 
virtual SharedPtr< XmlDocumentFragmentCreateDocumentFragment ()
 Creates an XmlDocumentFragment. More...
 
SharedPtr< XmlElementCreateElement (const String &name)
 Creates an element with the specified name. More...
 
virtual SharedPtr< XmlEntityReferenceCreateEntityReference (const String &name)
 Creates an XmlEntityReference with the specified name. More...
 
virtual SharedPtr< XmlProcessingInstructionCreateProcessingInstruction (const String &target, const String &data)
 Creates an XmlProcessingInstruction with the specified name and data. More...
 
virtual SharedPtr< XmlDeclarationCreateXmlDeclaration (const String &version, const String &encoding, const String &standalone)
 Creates an XmlDeclaration node with the specified values. More...
 
virtual SharedPtr< XmlTextCreateTextNode (const String &text)
 Creates an XmlText with the specified text. More...
 
virtual SharedPtr< XmlSignificantWhitespaceCreateSignificantWhitespace (const String &text)
 Creates an XmlSignificantWhitespace node. More...
 
SharedPtr< XPath::XPathNavigatorCreateNavigator () override
 Creates a new XPathNavigator object for navigating this document. More...
 
virtual SharedPtr< XmlWhitespaceCreateWhitespace (const String &text)
 Creates an XmlWhitespace node. More...
 
virtual SharedPtr< XmlNodeListGetElementsByTagName (String name)
 Returns an XmlNodeList containing a list of all descendant elements that match the specified name. More...
 
SharedPtr< XmlAttributeCreateAttribute (const String &qualifiedName, const String &namespaceURI)
 Creates an XmlAttribute with the specified qualified name and XmlNode::get_NamespaceURI. More...
 
SharedPtr< XmlElementCreateElement (const String &qualifiedName, const String &namespaceURI)
 Creates an XmlElement with the qualified name and XmlNode::get_NamespaceURI. More...
 
virtual SharedPtr< XmlNodeListGetElementsByTagName (String localName, String namespaceURI)
 Returns an XmlNodeList containing a list of all descendant elements that match the specified XmlDocument::get_LocalName and XmlNode::get_NamespaceURI. More...
 
virtual SharedPtr< XmlElementGetElementById (String elementId)
 Returns the XmlElement with the specified ID. More...
 
virtual SharedPtr< XmlNodeImportNode (SharedPtr< XmlNode > node, bool deep)
 Imports a node from another document to the current document. More...
 
virtual SharedPtr< XmlAttributeCreateAttribute (const String &prefix, const String &localName, const String &namespaceURI)
 Creates an XmlAttribute with the specified XmlNode::get_Prefix, XmlDocument::get_LocalName, and XmlNode::get_NamespaceURI. More...
 
virtual SharedPtr< XmlElementCreateElement (const String &prefix, const String &localName, const String &namespaceURI)
 Creates an element with the specified XmlNode::get_Prefix, XmlDocument::get_LocalName, and XmlNode::get_NamespaceURI. More...
 
virtual SharedPtr< XmlNodeCreateNode (XmlNodeType type, const String &prefix, const String &name, const String &namespaceURI)
 Creates a XmlNode with the specified XmlNodeType, XmlNode::get_Prefix, XmlDocument::get_Name, and XmlNode::get_NamespaceURI. More...
 
virtual SharedPtr< XmlNodeCreateNode (const String &nodeTypeString, const String &name, const String &namespaceURI)
 Creates an XmlNode with the specified node type, XmlDocument::get_Name, and XmlNode::get_NamespaceURI. More...
 
virtual SharedPtr< XmlNodeCreateNode (XmlNodeType type, const String &name, const String &namespaceURI)
 Creates an XmlNode with the specified XmlNodeType, XmlDocument::get_Name, and XmlNode::get_NamespaceURI. More...
 
virtual SharedPtr< XmlNodeReadNode (SharedPtr< XmlReader > reader)
 Creates an XmlNode object based on the information in the XmlReader. The reader must be positioned on a node or attribute. More...
 
virtual void Load (String filename)
 Loads the XML document from the specified URL. More...
 
virtual void Load (SharedPtr< IO::Stream > inStream)
 Loads the XML document from the specified stream. More...
 
virtual void Load (SharedPtr< IO::TextReader > txtReader)
 Loads the XML document from the specified TextReader. More...
 
virtual void Load (SharedPtr< XmlReader > reader)
 Loads the XML document from the specified XmlReader. More...
 
virtual void LoadXml (String xml)
 Loads the XML document from the specified string. More...
 
virtual void Save (String filename)
 Saves the XML document to the specified file. If the specified file exists, this method overwrites it. More...
 
virtual void Save (SharedPtr< IO::Stream > outStream)
 Saves the XML document to the specified stream. More...
 
virtual void Save (SharedPtr< IO::TextWriter > writer)
 Saves the XML document to the specified TextWriter. More...
 
virtual void Save (SharedPtr< XmlWriter > w)
 Saves the XML document to the specified XmlWriter. More...
 
void WriteTo (const SharedPtr< XmlWriter > &w) override
 Saves the XmlDocument node to the specified XmlWriter. More...
 
void WriteContentTo (const SharedPtr< XmlWriter > &xw) override
 Saves all the children of the XmlDocument node to the specified XmlWriter. More...
 
void Validate (Schema::ValidationEventHandler validationEventHandler)
 Validates the XmlDocument against the XML Schema Definition Language (XSD) schemas contained in the XmlDocument::get_Schemas list. More...
 
void Validate (Schema::ValidationEventHandler validationEventHandler, const SharedPtr< XmlNode > &nodeToValidate)
 Validates the XmlNode object specified against the XML Schema Definition Language (XSD) schemas in the XmlDocument::get_Schemas list. More...
 
- Public Member Functions inherited from System::Xml::XmlNode
virtual String get_Name ()=0
 Returns the qualified name of the node, when overridden in a derived class. More...
 
virtual String get_Value ()
 Returns the value of the node. More...
 
virtual void set_Value (String value)
 Sets the value of the node. More...
 
virtual XmlNodeType get_NodeType ()=0
 Returns the type of the current node, when overridden in a derived class. More...
 
virtual SharedPtr< XmlNodeget_ParentNode () final
 Returns the parent of this node (for nodes that can have parents). More...
 
virtual SharedPtr< XmlNodeListget_ChildNodes ()
 Returns all the child nodes of the node. More...
 
virtual SharedPtr< XmlNodeget_PreviousSibling () final
 Returns the node immediately preceding this node. More...
 
virtual SharedPtr< XmlNodeget_NextSibling () final
 Returns the node immediately following this node. More...
 
virtual SharedPtr< XmlAttributeCollectionget_Attributes () final
 Returns an XmlAttributeCollection containing the attributes of this node. More...
 
virtual SharedPtr< XmlDocumentget_OwnerDocument ()
 Returns the XmlDocument to which this node belongs. More...
 
virtual SharedPtr< XmlNodeget_FirstChild () final
 Returns the first child of the node. More...
 
virtual SharedPtr< XmlNodeget_LastChild () final
 Returns the last child of the node. More...
 
virtual bool get_HasChildNodes ()
 Returns a value indicating whether this node has any child nodes. More...
 
virtual String get_NamespaceURI ()
 Returns the namespace URI of this node. More...
 
virtual String get_Prefix ()
 Returns the namespace prefix of this node. More...
 
virtual void set_Prefix (String value)
 Sets the namespace prefix of this node. More...
 
virtual String get_LocalName ()=0
 Returns the local name of the node, when overridden in a derived class. More...
 
virtual bool get_IsReadOnly ()
 Returns a value indicating whether the node is read-only. More...
 
virtual String get_InnerText ()
 Returns the concatenated values of the node and all its child nodes. More...
 
virtual void set_InnerText (String value)
 Sets the concatenated values of the node and all its child nodes. More...
 
virtual String get_OuterXml ()
 Returns the markup containing this node and all its child nodes. More...
 
virtual String get_InnerXml ()
 Returns the markup representing only the child nodes of this node. More...
 
virtual void set_InnerXml (String value)
 Sets the markup representing only the child nodes of this node. More...
 
virtual 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 String get_BaseURI ()
 Returns the base URI of the current node. More...
 
virtual SharedPtr< XmlNodeget_PreviousText ()
 Returns the text node that immediately precedes this node. More...
 
SharedPtr< XPath::XPathNavigatorCreateNavigator () override
 Creates an XPathNavigator for navigating this object. More...
 
SharedPtr< XmlNodeSelectSingleNode (const String &xpath)
 Selects the first XmlNode that matches the XPath expression. More...
 
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...
 
SharedPtr< XmlNodeListSelectNodes (const String &xpath)
 Selects a list of nodes matching the XPath expression. More...
 
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 SharedPtr< XmlNodeInsertBefore (SharedPtr< XmlNode > newChild, SharedPtr< XmlNode > refChild)
 Inserts the specified node immediately before the specified reference node. More...
 
virtual SharedPtr< XmlNodeInsertAfter (SharedPtr< XmlNode > newChild, SharedPtr< XmlNode > refChild)
 Inserts the specified node immediately after the specified reference node. More...
 
virtual SharedPtr< XmlNodeReplaceChild (SharedPtr< XmlNode > newChild, SharedPtr< XmlNode > oldChild)
 Replaces the child node oldChild with newChild node. More...
 
virtual SharedPtr< XmlNodeRemoveChild (SharedPtr< XmlNode > oldChild)
 Removes specified child node. More...
 
virtual SharedPtr< XmlNodePrependChild (SharedPtr< XmlNode > newChild)
 Adds the specified node to the beginning of the list of child nodes for this node. More...
 
virtual SharedPtr< XmlNodeAppendChild (SharedPtr< XmlNode > newChild)
 Adds the specified node to the end of the list of child nodes, of this node. More...
 
virtual SharedPtr< XmlNodeCloneNode (bool deep)=0
 Creates a duplicate of the node, when overridden in a derived class. More...
 
virtual 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 bool Supports (String feature, String version)
 Tests if the DOM implementation implements a specific feature. More...
 
virtual SharedPtr< XmlNodeClone ()
 Creates a duplicate of this node. More...
 
SharedPtr< Collections::Generic::IEnumerator< SharedPtr< XmlNode > > > GetEnumerator () override
 Returns an enumerator that iterates through the child nodes in the current node. More...
 
virtual void WriteTo (const SharedPtr< XmlWriter > &w)=0
 Saves the current node to the specified XmlWriter, when overridden in a derived class. More...
 
virtual 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 void RemoveAll ()
 Removes all the child nodes and/or attributes of the current node. More...
 
virtual 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 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 SharedPtr< XmlElementidx_get (String name)
 Returns the first child element with the specified XmlNode::get_Name. More...
 
virtual 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 > >
virtual SharedPtr< IEnumerator< SharedPtr< System::Xml::XmlNode > > > GetEnumerator ()=0
 Gets enumerator. More...
 
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...
 
virtual virtualized_iteratorvirtualizeBeginIterator ()
 Gets the implementation of begin iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeEndIterator ()
 Gets the implementation of end iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeBeginConstIterator () const
 Gets the implementation of begin const iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeEndConstIterator () const
 Gets the implementation of end const iterator for the current container. 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...
 
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...
 
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 TypeInfoGetType () 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< XPathNavigatorCreateNavigator ()=0
 Returns a new XPathNavigator object. More...
 

Public Attributes

XmlNodeChangedEventHandler NodeInserting
 Occurs when a node belonging to this document is about to be inserted into another node. More...
 
XmlNodeChangedEventHandler NodeInserted
 Occurs when a node belonging to this document has been inserted into another node. More...
 
XmlNodeChangedEventHandler NodeRemoving
 Occurs when a node belonging to this document is about to be removed from the document. More...
 
XmlNodeChangedEventHandler NodeRemoved
 Occurs when a node belonging to this document has been removed from its parent. More...
 
XmlNodeChangedEventHandler NodeChanging
 Occurs when the XmlNode::get_Value of a node belonging to this document is about to be changed. More...
 
XmlNodeChangedEventHandler NodeChanged
 Occurs when the XmlNode::get_Value of a node belonging to this document has been changed. More...
 

Protected Member Functions

 XmlDocument (const SharedPtr< XmlImplementation > &imp)
 Initializes a new instance of the XmlDocument class with the specified XmlImplementation. More...
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (XmlDocument, CODEPORTING_ARGS(SharedPtr< XmlImplementation > imp))
 
virtual SharedPtr< XPath::XPathNavigatorCreateNavigator (SharedPtr< XmlNode > node)
 Creates an XPathNavigator object for navigating this document positioned on the XmlNode specified. More...
 
virtual SharedPtr< XmlAttributeCreateDefaultAttribute (const String &prefix, const String &localName, const String &namespaceURI)
 Creates a default attribute with the specified prefix, local name and namespace URI. More...
 
virtual ~XmlDocument ()
 
- Protected Member Functions inherited from System::Xml::XmlNode
virtual ~XmlNode ()
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< SharedPtr< System::Xml::XmlNode > >
 ~IEnumerable () override
 Destructor. More...
 
virtualized_iteratorGetEnumeratorAsVirtualizedIterator ()
 Gets enumerator instance and prepares it to be used as iterator kernel. More...
 
virtualized_iteratorGetEnumeratorAsVirtualizedIterator () const
 Gets enumerator instance and prepares it to be used as iterator kernel. 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...
 
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...
 

Detailed Description

Represents an XML document. You can use this class to load, validate, edit, add, and position XML in a document.

Attention
Objects of this class should only be allocated using System::MakeObject() function. Never create instances of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Member Typedef Documentation

◆ Ptr

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

Constructor & Destructor Documentation

◆ XmlDocument() [1/3]

System::Xml::XmlDocument::XmlDocument ( )

Initializes a new instance of the XmlDocument class.

◆ XmlDocument() [2/3]

System::Xml::XmlDocument::XmlDocument ( const SharedPtr< XmlNameTable > &  nt)

Initializes a new instance of the XmlDocument class with the specified XmlNameTable.

Parameters
ntThe XmlNameTable to use.

◆ XmlDocument() [3/3]

System::Xml::XmlDocument::XmlDocument ( const SharedPtr< XmlImplementation > &  imp)
protected

Initializes a new instance of the XmlDocument class with the specified XmlImplementation.

Parameters
impThe XmlImplementation to use.

◆ ~XmlDocument()

virtual System::Xml::XmlDocument::~XmlDocument ( )
protectedvirtual

Member Function Documentation

◆ CloneNode()

SharedPtr< XmlNode > System::Xml::XmlDocument::CloneNode ( bool  deep)
overridevirtual

Creates a duplicate of this node.

Parameters
deeptrue to recursively clone the subtree under the specified node; false to clone only the node itself.
Returns
The cloned XmlDocument node.

Implements System::Xml::XmlNode.

◆ CreateAttribute() [1/3]

SharedPtr< XmlAttribute > System::Xml::XmlDocument::CreateAttribute ( const String name)

Creates an XmlAttribute with the specified name.

Parameters
nameThe qualified name of the attribute. If the name contains a colon, the XmlNode::get_Prefix value reflects the part of the name preceding the first colon and the XmlDocument::get_LocalName value reflects the part of the name following the first colon. The XmlNode::get_NamespaceURI remains empty unless the prefix is a recognized built-in prefix such as xmlns. In this case get_NamespaceURI has a value of http://www.w3.org/2000/xmlns/.
Returns
The new XmlAttribute.

◆ CreateAttribute() [2/3]

virtual SharedPtr< XmlAttribute > System::Xml::XmlDocument::CreateAttribute ( const String prefix,
const String localName,
const String namespaceURI 
)
virtual

Creates an XmlAttribute with the specified XmlNode::get_Prefix, XmlDocument::get_LocalName, and XmlNode::get_NamespaceURI.

Parameters
prefixThe prefix of the attribute (if any). String::Empty and nullptr are equivalent.
localNameThe local name of the attribute.
namespaceURIThe namespace URI of the attribute (if any). String::Empty and nullptr are equivalent. If prefix is xmlns, then this parameter must be http://www.w3.org/2000/xmlns/; otherwise an exception is thrown.
Returns
The new XmlAttribute.

◆ CreateAttribute() [3/3]

SharedPtr< XmlAttribute > System::Xml::XmlDocument::CreateAttribute ( const String qualifiedName,
const String namespaceURI 
)

Creates an XmlAttribute with the specified qualified name and XmlNode::get_NamespaceURI.

Parameters
qualifiedNameThe qualified name of the attribute. If the name contains a colon then the XmlNode::get_Prefix value will reflect the part of the name preceding the colon and the XmlDocument::get_LocalName value will reflect the part of the name after the colon.
namespaceURIThe namespaceURI of the attribute. If the qualified name includes a prefix of xmlns, then this parameter must be http://www.w3.org/2000/xmlns/.
Returns
The new XmlAttribute.

◆ CreateCDataSection()

virtual SharedPtr< XmlCDataSection > System::Xml::XmlDocument::CreateCDataSection ( const String data)
virtual

Creates an XmlCDataSection containing the specified data.

Parameters
dataThe content of the new XmlCDataSection.
Returns
The new XmlCDataSection.

◆ CreateComment()

virtual SharedPtr< XmlComment > System::Xml::XmlDocument::CreateComment ( const String data)
virtual

Creates an XmlComment containing the specified data.

Parameters
dataThe content of the new XmlComment.
Returns
The new XmlComment.

◆ CreateDefaultAttribute()

virtual SharedPtr< XmlAttribute > System::Xml::XmlDocument::CreateDefaultAttribute ( const String prefix,
const String localName,
const String namespaceURI 
)
protectedvirtual

Creates a default attribute with the specified prefix, local name and namespace URI.

Parameters
prefixThe prefix of the attribute (if any).
localNameThe local name of the attribute.
namespaceURIThe namespace URI of the attribute (if any).
Returns
The new XmlAttribute.

◆ CreateDocumentFragment()

virtual SharedPtr< XmlDocumentFragment > System::Xml::XmlDocument::CreateDocumentFragment ( )
virtual

Creates an XmlDocumentFragment.

Returns
The new XmlDocumentFragment.

◆ CreateDocumentType()

virtual SharedPtr< XmlDocumentType > System::Xml::XmlDocument::CreateDocumentType ( const String name,
const String publicId,
const String systemId,
const String internalSubset 
)
virtual

Returns a new XmlDocumentType object.

Parameters
nameName of the document type.
publicIdThe public identifier of the document type or nullptr. You can specify a public URI and also a system identifier to identify the location of the external DTD subset.
systemIdThe system identifier of the document type or nullptr. Specifies the URL of the file location for the external DTD subset.
internalSubsetThe DTD internal subset of the document type or nullptr.
Returns
The new XmlDocumentType.

◆ CreateElement() [1/3]

SharedPtr< XmlElement > System::Xml::XmlDocument::CreateElement ( const String name)

Creates an element with the specified name.

Parameters
nameThe qualified name of the element. If the name contains a colon then the XmlNode::get_Prefix value reflects the part of the name preceding the colon and the XmlDocument::get_LocalName value reflects the part of the name after the colon. The qualified name cannot include a prefix of xmlns.
Returns
The new XmlElement.

◆ CreateElement() [2/3]

virtual SharedPtr< XmlElement > System::Xml::XmlDocument::CreateElement ( const String prefix,
const String localName,
const String namespaceURI 
)
virtual

Creates an element with the specified XmlNode::get_Prefix, XmlDocument::get_LocalName, and XmlNode::get_NamespaceURI.

Parameters
prefixThe prefix of the new element (if any). String::Empty and nullptr are equivalent.
localNameThe local name of the new element.
namespaceURIThe namespace URI of the new element (if any). String::Empty and nullptr are equivalent.
Returns
The new XmlElement.

◆ CreateElement() [3/3]

SharedPtr< XmlElement > System::Xml::XmlDocument::CreateElement ( const String qualifiedName,
const String namespaceURI 
)

Creates an XmlElement with the qualified name and XmlNode::get_NamespaceURI.

Parameters
qualifiedNameThe qualified name of the element. If the name contains a colon then the XmlNode::get_Prefix value will reflect the part of the name preceding the colon and the XmlDocument::get_LocalName value will reflect the part of the name after the colon. The qualified name cannot include a prefix of xmlns.
namespaceURIThe namespace URI of the element.
Returns
The new XmlElement.

◆ CreateEntityReference()

virtual SharedPtr< XmlEntityReference > System::Xml::XmlDocument::CreateEntityReference ( const String name)
virtual

Creates an XmlEntityReference with the specified name.

Parameters
nameThe name of the entity reference.
Returns
The new XmlEntityReference.
Exceptions
ArgumentExceptionThe name is invalid (for example, names starting with '#' are invalid.)

◆ CreateNavigator() [1/2]

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

Creates a new XPathNavigator object for navigating this document.

Returns
An XPathNavigator object.

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

◆ CreateNavigator() [2/2]

virtual SharedPtr< XPath::XPathNavigator > System::Xml::XmlDocument::CreateNavigator ( SharedPtr< XmlNode node)
protectedvirtual

Creates an XPathNavigator object for navigating this document positioned on the XmlNode specified.

Parameters
nodeThe XmlNode you want the navigator initially positioned on.
Returns
An XPathNavigator object.

◆ CreateNode() [1/3]

virtual SharedPtr< XmlNode > System::Xml::XmlDocument::CreateNode ( const String nodeTypeString,
const String name,
const String namespaceURI 
)
virtual

Creates an XmlNode with the specified node type, XmlDocument::get_Name, and XmlNode::get_NamespaceURI.

Parameters
nodeTypeStringString version of the XmlNodeType of the new node. This parameter must be one of the values listed in the table below.
nameThe qualified name of the new node. If the name contains a colon, it is parsed into XmlNode::get_Prefix and XmlDocument::get_LocalName components.
namespaceURIThe namespace URI of the new node.
Returns
The new XmlNode.
Exceptions
ArgumentExceptionThe name was not provided and the XmlNodeType requires a name; or nodeTypeString is not one of the strings listed below.

The nodeTypeString parameter is case sensitive and must be one of the values in the following table:

nodeTypeStringXmlNodeType
attributeAttribute
cdatasectionCDATA
commentComment
documentDocument
documentfragmentDocumentFragment
documenttypeDocumentType
elementElement
entityreferenceEntityReference
processinginstructionProcessingInstruction
significantwhitespaceSignificantWhitespace
textText
whitespaceWhitespace

◆ CreateNode() [2/3]

virtual SharedPtr< XmlNode > System::Xml::XmlDocument::CreateNode ( XmlNodeType  type,
const String name,
const String namespaceURI 
)
virtual

Creates an XmlNode with the specified XmlNodeType, XmlDocument::get_Name, and XmlNode::get_NamespaceURI.

Parameters
typeThe XmlNodeType of the new node.
nameThe qualified name of the new node. If the name contains a colon then it is parsed into XmlNode::get_Prefix and XmlDocument::get_LocalName components.
namespaceURIThe namespace URI of the new node.
Returns
The new XmlNode.
Exceptions
ArgumentExceptionThe name was not provided and the XmlNodeType requires a name.

◆ CreateNode() [3/3]

virtual SharedPtr< XmlNode > System::Xml::XmlDocument::CreateNode ( XmlNodeType  type,
const String prefix,
const String name,
const String namespaceURI 
)
virtual

Creates a XmlNode with the specified XmlNodeType, XmlNode::get_Prefix, XmlDocument::get_Name, and XmlNode::get_NamespaceURI.

Parameters
typeThe XmlNodeType of the new node.
prefixThe prefix of the new node.
nameThe local name of the new node.
namespaceURIThe namespace URI of the new node.
Returns
The new XmlNode.
Exceptions
ArgumentExceptionThe name was not provided and the XmlNodeType requires a name.

◆ CreateProcessingInstruction()

virtual SharedPtr< XmlProcessingInstruction > System::Xml::XmlDocument::CreateProcessingInstruction ( const String target,
const String data 
)
virtual

Creates an XmlProcessingInstruction with the specified name and data.

Parameters
targetThe name of the processing instruction.
dataThe data for the processing instruction.
Returns
The new XmlProcessingInstruction.

◆ CreateSignificantWhitespace()

virtual SharedPtr< XmlSignificantWhitespace > System::Xml::XmlDocument::CreateSignificantWhitespace ( const String text)
virtual

Creates an XmlSignificantWhitespace node.

Parameters
textThe string must contain only the following characters '\x20', '\x0d', '\x0a', '\x09'.
Returns
A new XmlSignificantWhitespace node.

◆ CreateTextNode()

virtual SharedPtr< XmlText > System::Xml::XmlDocument::CreateTextNode ( const String text)
virtual

Creates an XmlText with the specified text.

Parameters
textThe text for the Text node.
Returns
The new XmlText node.

◆ CreateWhitespace()

virtual SharedPtr< XmlWhitespace > System::Xml::XmlDocument::CreateWhitespace ( const String text)
virtual

Creates an XmlWhitespace node.

Parameters
textThe string must contain only the following characters '\x20', '\x0d', '\x0a', '\x09'.
Returns
A new XmlWhitespace node.

◆ CreateXmlDeclaration()

virtual SharedPtr< XmlDeclaration > System::Xml::XmlDocument::CreateXmlDeclaration ( const String version,
const String encoding,
const String standalone 
)
virtual

Creates an XmlDeclaration node with the specified values.

Parameters
versionThe version must be "1.0".
encodingThe value of the encoding attribute. This is the encoding that is used when you save the XmlDocument to a file or a stream; therefore, it must be set to a string supported by the Text::Encoding class, otherwise "XmlDocument::Save(String)" fails. If this is nullptr or String::Empty, the XmlDocument::Save method does not write an encoding attribute on the XML declaration and therefore the default encoding, UTF-8, is used.

Note: If the XmlDocument is saved to either a TextWriter or an XmlTextWriter, this encoding value is discarded. Instead, the encoding of the TextWriter or the XmlTextWriter is used. This ensures that the XML written out can be read back using the correct encoding.

Parameters
standaloneThe value must be either "yes" or "no". If this is nullptr or String::Empty, the XmlDocument::Save method does not write a standalone attribute on the XML declaration.
Returns
The new XmlDeclaration node.
Exceptions
ArgumentExceptionThe values of version or standalone are something other than the ones specified above.

◆ get_BaseURI()

String System::Xml::XmlDocument::get_BaseURI ( )
overridevirtual

Returns the base URI of the current node.

Returns
The location from which the node was loaded.

Reimplemented from System::Xml::XmlNode.

◆ get_DocumentElement()

SharedPtr< XmlElement > System::Xml::XmlDocument::get_DocumentElement ( )

Returns the root XmlElement for the document.

Returns
The XmlElement that represents the root of the XML document tree. If no root exists, nullptr is returned.

◆ get_DocumentType()

virtual SharedPtr< XmlDocumentType > System::Xml::XmlDocument::get_DocumentType ( )
virtual

Returns the node containing the DOCTYPE declaration.

Returns
The XmlNode containing the DocumentType (DOCTYPE declaration).

◆ get_Implementation()

SharedPtr< XmlImplementation > System::Xml::XmlDocument::get_Implementation ( )

Returns the XmlImplementation object for the current document.

Returns
The XmlImplementation object for the current document.

◆ get_InnerXml()

String System::Xml::XmlDocument::get_InnerXml ( )
overridevirtual

Returns the markup representing the children of the current node.

Returns
The markup of the children of the current node.

Reimplemented from System::Xml::XmlNode.

◆ get_IsReadOnly()

bool System::Xml::XmlDocument::get_IsReadOnly ( )
overridevirtual

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

Returns
true if the current node is read-only; otherwise false. XmlDocument nodes always return false.

Reimplemented from System::Xml::XmlNode.

◆ get_LocalName()

String System::Xml::XmlDocument::get_LocalName ( )
overridevirtual

Returns the local name of the node.

Returns
For XmlDocument nodes, the local name is #document.

Implements System::Xml::XmlNode.

◆ get_Name()

String System::Xml::XmlDocument::get_Name ( )
overridevirtual

Returns the qualified name of the node.

Returns
For XmlDocument nodes, the name is #document.

Implements System::Xml::XmlNode.

◆ get_NameTable()

SharedPtr< XmlNameTable > System::Xml::XmlDocument::get_NameTable ( )

Returns the XmlNameTable associated with this implementation.

Returns
An XmlNameTable enabling you to get the atomized version of a string within the document.

◆ get_NodeType()

XmlNodeType System::Xml::XmlDocument::get_NodeType ( )
overridevirtual

Returns the type of the current node.

Returns
The node type. For XmlDocument nodes, this value is XmlNodeType::Document.

Implements System::Xml::XmlNode.

◆ get_OwnerDocument()

SharedPtr< XmlDocument > System::Xml::XmlDocument::get_OwnerDocument ( )
overridevirtual

Returns the XmlDocument to which the current node belongs.

Returns
For XmlDocument nodes (XmlDocument::get_NodeType equals XmlNodeType::Document), this method always returns nullptr.

Reimplemented from System::Xml::XmlNode.

◆ get_PreserveWhitespace()

bool System::Xml::XmlDocument::get_PreserveWhitespace ( )

Returns a value indicating whether to preserve white space in element content.

Returns
true to preserve white space; otherwise false. The default is false.

◆ get_SchemaInfo()

SharedPtr< Schema::IXmlSchemaInfo > System::Xml::XmlDocument::get_SchemaInfo ( )
overridevirtual

Returns the Post-Schema-Validation-Infoset (PSVI) of the node.

Returns
The IXmlSchemaInfo object representing the PSVI of the node.

Reimplemented from System::Xml::XmlNode.

◆ get_Schemas()

SharedPtr< Schema::XmlSchemaSet > System::Xml::XmlDocument::get_Schemas ( )

Returns the XmlSchemaSet object associated with this XmlDocument.

Returns
An XmlSchemaSet object containing the XML Schema Definition Language (XSD) schemas associated with this XmlDocument; otherwise, an empty XmlSchemaSet object.

◆ GetElementById()

virtual SharedPtr< XmlElement > System::Xml::XmlDocument::GetElementById ( String  elementId)
virtual

Returns the XmlElement with the specified ID.

Parameters
elementIdThe attribute ID to match.
Returns
The XmlElement with the matching ID or nullptr if no matching element is found.

◆ GetElementsByTagName() [1/2]

virtual SharedPtr< XmlNodeList > System::Xml::XmlDocument::GetElementsByTagName ( String  localName,
String  namespaceURI 
)
virtual

Returns an XmlNodeList containing a list of all descendant elements that match the specified XmlDocument::get_LocalName and XmlNode::get_NamespaceURI.

Parameters
localNameThe LocalName to match. The special value "*" matches all tags.
namespaceURINamespaceURI to match.
Returns
An XmlNodeList containing a list of all matching nodes. If no nodes match the specified localName and namespaceURI, the returned collection will be empty.

◆ GetElementsByTagName() [2/2]

virtual SharedPtr< XmlNodeList > System::Xml::XmlDocument::GetElementsByTagName ( String  name)
virtual

Returns an XmlNodeList containing a list of all descendant elements that match the specified name.

Parameters
nameThe qualified name to match. It is matched against the get_Name value of the matching node. The special value "*" matches all tags.
Returns
An XmlNodeList containing a list of all matching nodes. If no nodes match name, the returned collection will be empty.

◆ ImportNode()

virtual SharedPtr< XmlNode > System::Xml::XmlDocument::ImportNode ( SharedPtr< XmlNode node,
bool  deep 
)
virtual

Imports a node from another document to the current document.

Parameters
nodeThe node being imported.
deeptrue to perform a deep clone; otherwise, false.
Returns
The imported XmlNode.
Exceptions
InvalidOperationExceptionCalling this method on a node type which cannot be imported.

◆ Load() [1/4]

virtual void System::Xml::XmlDocument::Load ( SharedPtr< IO::Stream inStream)
virtual

Loads the XML document from the specified stream.

Parameters
inStreamThe stream containing the XML document to load.
Exceptions
XmlExceptionThere is a load or parse error in the XML. In this case, a FileNotFoundException is raised.

◆ Load() [2/4]

virtual void System::Xml::XmlDocument::Load ( SharedPtr< IO::TextReader txtReader)
virtual

Loads the XML document from the specified TextReader.

Parameters
txtReaderThe TextReader used to feed the XML data into the document.
Exceptions
XmlExceptionThere is a load or parse error in the XML. In this case, the document remains empty.

◆ Load() [3/4]

virtual void System::Xml::XmlDocument::Load ( SharedPtr< XmlReader reader)
virtual

Loads the XML document from the specified XmlReader.

Parameters
readerThe XmlReader used to feed the XML data into the document.
Exceptions
XmlExceptionThere is a load or parse error in the XML. In this case, the document remains empty.

◆ Load() [4/4]

virtual void System::Xml::XmlDocument::Load ( String  filename)
virtual

Loads the XML document from the specified URL.

Parameters
filenameURL for the file containing the XML document to load. The URL can be either a local file or an HTTP URL (a Web address).
Exceptions
XmlExceptionThere is a load or parse error in the XML. In this case, a FileNotFoundException is raised.
ArgumentExceptionfilename is a zero-length string, contains only white space, or contains one or more invalid characters as defined by System::IO::Path::GetInvalidPathChars.
ArgumentNullExceptionfilename is nullptr.
PathTooLongExceptionThe specified path, file name, or both exceed the system-defined maximum length.
DirectoryNotFoundExceptionThe specified path is invalid (for example, it is on an unmapped drive).
IOExceptionAn I/O error occurred while opening the file.
UnauthorizedAccessExceptionfilename specified a file that is read-only. This operation is not supported on the current platform. filename specified a directory. The caller does not have the required permission.
FileNotFoundExceptionThe file specified in filename was not found.
NotSupportedExceptionfilename is in an invalid format.
SecurityExceptionThe caller does not have the required permission.

◆ LoadXml()

virtual void System::Xml::XmlDocument::LoadXml ( String  xml)
virtual

Loads the XML document from the specified string.

Parameters
xmlString containing the XML document to load.
Exceptions
XmlExceptionThere is a load or parse error in the XML. In this case, the document remains empty.

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

System::Xml::XmlDocument::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( XmlDocument  ,
CODEPORTING_ARGS(SharedPtr< XmlImplementation > imp)   
)
protected

◆ ReadNode()

virtual SharedPtr< XmlNode > System::Xml::XmlDocument::ReadNode ( SharedPtr< XmlReader reader)
virtual

Creates an XmlNode object based on the information in the XmlReader. The reader must be positioned on a node or attribute.

Parameters
readerThe XML source.
Returns
The new XmlNode or nullptr if no more nodes exist.
Exceptions
NullReferenceExceptionThe reader is positioned on a node type that does not translate to a valid DOM node (for example, EndElement or EndEntity).

◆ Save() [1/4]

virtual void System::Xml::XmlDocument::Save ( SharedPtr< IO::Stream outStream)
virtual

Saves the XML document to the specified stream.

Parameters
outStreamThe stream to which you want to save.
Exceptions
XmlExceptionThe operation would not result in a well formed XML document (for example, no document element or duplicate XML declarations).

◆ Save() [2/4]

virtual void System::Xml::XmlDocument::Save ( SharedPtr< IO::TextWriter writer)
virtual

Saves the XML document to the specified TextWriter.

Parameters
writerThe TextWriter to which you want to save.
Exceptions
XmlExceptionThe operation would not result in a well formed XML document (for example, no document element or duplicate XML declarations).

◆ Save() [3/4]

virtual void System::Xml::XmlDocument::Save ( SharedPtr< XmlWriter w)
virtual

Saves the XML document to the specified XmlWriter.

Parameters
wThe XmlWriter to which you want to save.
Exceptions
XmlExceptionThe operation would not result in a well formed XML document (for example, no document element or duplicate XML declarations).

◆ Save() [4/4]

virtual void System::Xml::XmlDocument::Save ( String  filename)
virtual

Saves the XML document to the specified file. If the specified file exists, this method overwrites it.

Parameters
filenameThe location of the file where you want to save the document.
Exceptions
XmlExceptionThe operation would not result in a well formed XML document (for example, no document element or duplicate XML declarations).

◆ set_InnerText()

void System::Xml::XmlDocument::set_InnerText ( String  value)
overridevirtual

Throws an InvalidOperationException in all cases.

Parameters
valueThe value to set.
Exceptions
InvalidOperationExceptionIn all cases.

Reimplemented from System::Xml::XmlNode.

◆ set_InnerXml()

void System::Xml::XmlDocument::set_InnerXml ( String  value)
overridevirtual

Sets the markup representing the children of the current node.

Parameters
valueThe value to set.
Exceptions
XmlExceptionThe XML specified when setting this value is not well-formed.

Reimplemented from System::Xml::XmlNode.

◆ set_PreserveWhitespace()

void System::Xml::XmlDocument::set_PreserveWhitespace ( bool  value)

Sets a value indicating whether to preserve white space in element content.

Parameters
valueThe value to set.

◆ set_Schemas()

void System::Xml::XmlDocument::set_Schemas ( const SharedPtr< Schema::XmlSchemaSet > &  value)

Sets the XmlSchemaSet object associated with this XmlDocument.

Parameters
valueThe value to set.

◆ set_XmlResolver()

virtual void System::Xml::XmlDocument::set_XmlResolver ( SharedPtr< System::Xml::XmlResolver value)
virtual

Sets the XmlResolver to use for resolving external resources.

Parameters
valueThe value to set.
Exceptions
XmlExceptionThis value is set to nullptr and an external DTD or entity is encountered.

◆ Validate() [1/2]

void System::Xml::XmlDocument::Validate ( Schema::ValidationEventHandler  validationEventHandler)

Validates the XmlDocument against the XML Schema Definition Language (XSD) schemas contained in the XmlDocument::get_Schemas list.

Parameters
validationEventHandlerThe Schema::ValidationEventHandler object that receives information about schema validation warnings and errors.
Exceptions
XmlSchemaValidationExceptionA schema validation event occurred and no Schema::ValidationEventHandler object was specified.

◆ Validate() [2/2]

void System::Xml::XmlDocument::Validate ( Schema::ValidationEventHandler  validationEventHandler,
const SharedPtr< XmlNode > &  nodeToValidate 
)

Validates the XmlNode object specified against the XML Schema Definition Language (XSD) schemas in the XmlDocument::get_Schemas list.

Parameters
validationEventHandlerThe Schema::ValidationEventHandler object that receives information about schema validation warnings and errors.
nodeToValidateThe XmlNode object created from an XmlDocument to validate.
Exceptions
ArgumentExceptionThe XmlNode object parameter was not created from an XmlDocument.
InvalidOperationExceptionThe XmlNode object parameter is not an element, attribute, document fragment, or the root node.
XmlSchemaValidationExceptionA schema validation event occurred and no Schema::ValidationEventHandler object was specified.

◆ WriteContentTo()

void System::Xml::XmlDocument::WriteContentTo ( const SharedPtr< XmlWriter > &  xw)
overridevirtual

Saves all the children of the XmlDocument node to the specified XmlWriter.

Parameters
xwThe XmlWriter to which you want to save.

Implements System::Xml::XmlNode.

◆ WriteTo()

void System::Xml::XmlDocument::WriteTo ( const SharedPtr< XmlWriter > &  w)
overridevirtual

Saves the XmlDocument node to the specified XmlWriter.

Parameters
wThe XmlWriter to which you want to save.

Implements System::Xml::XmlNode.

Member Data Documentation

◆ NodeChanged

XmlNodeChangedEventHandler System::Xml::XmlDocument::NodeChanged

Occurs when the XmlNode::get_Value of a node belonging to this document has been changed.

◆ NodeChanging

XmlNodeChangedEventHandler System::Xml::XmlDocument::NodeChanging

Occurs when the XmlNode::get_Value of a node belonging to this document is about to be changed.

◆ NodeInserted

XmlNodeChangedEventHandler System::Xml::XmlDocument::NodeInserted

Occurs when a node belonging to this document has been inserted into another node.

◆ NodeInserting

XmlNodeChangedEventHandler System::Xml::XmlDocument::NodeInserting

Occurs when a node belonging to this document is about to be inserted into another node.

◆ NodeRemoved

XmlNodeChangedEventHandler System::Xml::XmlDocument::NodeRemoved

Occurs when a node belonging to this document has been removed from its parent.

◆ NodeRemoving

XmlNodeChangedEventHandler System::Xml::XmlDocument::NodeRemoving

Occurs when a node belonging to this document is about to be removed from the document.