Asposecpplib

Represents an XML document. Objects of this class should only be allocated using System::MakeObject() function. Never create instance 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. More...

Inherits System::Xml::XmlNode.

Public Types

typedef SharedPtr< XmlDocumentPtr
 An alias for shared pointer to an instance of this class. More...
 
- Public Types inherited from System::Xml::XmlNode
typedef SharedPtr< XmlNodePtr
 An alias for shared pointer to an instance of this class. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

 XmlDocument ()
 Default constructor. Constructs a new instance of XmlDocument class. More...
 
 XmlDocument (xmlDoc *native)
 Constructs a new instance of XmlDocument class that represents the specified XML document. More...
 
 XmlDocument (const XmlNameTable::Ptr &nameTable)
 Constructs a new instance of XmlDocument class that uses the specified. More...
 
void Load (const String &filename)
 Loads an XML document from the specified URL; URL can be a file or an HTTP URL. More...
 
void Load (const SharedPtr< System::IO::Stream > &stream)
 Loads an XML document from the specified stream. More...
 
void Load (const SharedPtr< System::IO::TextReader > &reader)
 Loads an XML document from the specified TextReader object. More...
 
void Load (const SharedPtr< XmlReader > &reader)
 Loads an XML document from the specified XmlReader object. More...
 
void LoadXml (const String &xml)
 Loads an XML document from the specified string. More...
 
void Validate (const Schema::ValidationEventHandler &event_handler)
 
void Save (const String &filename) const
 Saves the XML document represented by the current object to the specified file. More...
 
void Save (const SharedPtr< System::IO::Stream > &stream) const
 Saves the XML document represented by the current object to the specified stream. More...
 
void Save (const SharedPtr< System::IO::TextWriter > &writer) const
 Saves the XML document represented by the current object to the specified TextWriter object. More...
 
void Save (const SharedPtr< XmlWriter > &writer) const
 Saves the XML document represented by the current object to the specified XmlWriter object. More...
 
String get_BaseURI () const override
 Gets the base URI of the current document. More...
 
String get_Name () const override
 Returns the name of the node represented by the current object. More...
 
String get_Value () const override
 Returns the value of the XML node represented by the current object. More...
 
String get_OuterXml () const override
 Returns the XML markup of the XML node represented by the current object and all its child nodes. More...
 
XmlNode::Ptr get_FirstChild () const override
 Returns the first child of the node represented by the current object. More...
 
XmlNode::Ptr get_LastChild () const override
 Returns the last child of the node represented by the current object. More...
 
XmlNode::Ptr get_NextSibling () const override
 Returns the next sibling of the node represented by the current object. More...
 
XmlNode::Ptr get_PreviousSibling () const override
 Returns the previous sibling of the node represented by the current object. More...
 
XmlNode::Ptr get_ParentNode () const override
 Returns the parent node of the node represented by the current object. More...
 
SharedPtr< XmlDocumentget_OwnerDocument () const override
 Returns a shared pointer to an XmlDocument object representing an XML document node to which the node represented by the current object belongs. More...
 
XmlElement::Ptr get_DocumentElement ()
 Returns the root XmlElement of the XML document node represented by the current object. More...
 
XmlNameTable::Ptr get_NameTable ()
 Returns the XmlNameTable object associated with the current object. More...
 
bool get_PreserveWhitespace () const
 Returns a value indicating whether to preserve insignificant white spaces in XML content. More...
 
XmlDocumentType::Ptr get_DocumentType () const
 Gets the node containing the DOCTYPE declaration. More...
 
void set_InnerText (String text) override
 NOT APPLICABLE. More...
 
void set_PreserveWhitespace (bool value)
 Sets a value indicating whether to preserve insignificant white spaces in XML content. More...
 
XmlElement::Ptr idx_get (String name) const override
 Returns an XmlElement object representing an XML element with the specified name which is a child of the node represented by the current object. More...
 
virtual void WriteContentTo (SharedPtr< XmlWriter > writer) override
 Saves all children of the XML document node represented by the current object to the specified XmlWriter object. More...
 
virtual void WriteTo (SharedPtr< XmlWriter > writer) override
 Saves the XML document node represented by the current object to the specified XmlWriter object. More...
 
virtual SharedPtr< XmlAttributeCreateAttribute (const String &name)
 Creates an attribute with the specified name. More...
 
virtual SharedPtr< XmlAttributeCreateAttribute (const String &qualifiedName, const String &namespaceURI)
 Creates an attribute with the specified qualified name and namespace URI. More...
 
virtual SharedPtr< XmlAttributeCreateAttribute (const String &prefix, const String &localName, const String &namespaceURI)
 Creates an attribute with the specified prefix, local name and namespace URI. More...
 
SharedPtr< XmlNodeCreateNode (XmlNodeType type, const String &qname, const String &namespaceURI=u"")
 Creates an XmlNode object representing an XML node of the specified type with the specified qualified name and namespace URI. More...
 
SharedPtr< XmlElementCreateElement (const String &qname)
 Creates an XmlElement object representing an XML element with the specified qualified name. More...
 
SharedPtr< XmlElementCreateElement (const String &qualifiedName, const String &namespaceURI)
 Creates an XmlElement object representing an XML element with the specified qualified name and namespace URI. More...
 
virtual SharedPtr< XmlElementCreateElement (const String &prefix, const String &localName, const String &namespaceURI)
 Creates an XmlElement object representing an XML element with the specified prefix, local name and namespace URI. More...
 
SharedPtr< XmlTextCreateTextNode (const String &text)
 Creates an XmlText object representing an XML text node with the specified content. More...
 
SharedPtr< XmlCommentCreateComment (const String &text)
 Creates an XmlComment object representing an XML comment node with the specified content. More...
 
SharedPtr< XmlDeclarationCreateXmlDeclaration (const String &version, const String &encoding=u"", const String &standalone=u"")
 Creates an XmlDeclaration object representing an XML declaration node with the specified values of 'version', 'encoding' and 'standalone' attributes. More...
 
SharedPtr< XmlProcessingInstructionCreateProcessingInstruction (const String &target, const String &data)
 Creates an XmlProcessingInstruction object representing an XML processing instruction node with the specified values of 'target' and 'data' attributes. More...
 
SharedPtr< XmlCDataSectionCreateCDataSection (const String &data)
 Creates an XmlCDataSection object representing an XML CDATA section node with the specified content. More...
 
SharedPtr< XmlDocumentFragmentCreateDocumentFragment ()
 Creates an XmlDocumentFragment object. More...
 
System::SharedPtr< XmlSignificantWhitespace > CreateSignificantWhitespace (String text)
 Creates an XmlSignificantWhitespace object. More...
 
System::SharedPtr< XmlWhitespace > CreateWhitespace (String text)
 Creates an XmlWhitespace object. More...
 
System::SharedPtr< XmlAttributeCreateDefaultAttribute (String prefix, String localName, String namespaceURI)
 Creates attribute with default value. More...
 
SharedPtr< XmlNodeImportNode (const SharedPtr< XmlNode > &node, bool deep)
 Imports the specified XML node from another XML document. More...
 
XmlNode::Ptr AppendChild (XmlNode::Ptr child) override
 Adds the specified XML node at the end of the list of children of the XML document represented by the current object. More...
 
XmlNode::Ptr PrependChild (XmlNode::Ptr child) override
 Adds the specified XML node at the beginning of the list of children of the XML document represented by the current object. More...
 
XmlNode::Ptr InsertBefore (XmlNode::Ptr child, XmlNode::Ptr ref_child) override
 Adds the specified XML node to the list of children of the XML document represented by the current object at the position prior to the position of the specified reference child node. More...
 
XmlNode::Ptr InsertAfter (XmlNode::Ptr child, XmlNode::Ptr ref_child) override
 Adds the specified XML node to the list of children of the XML document represented by the current object at the position next to the position of the specified reference child node. More...
 
XmlNode::Ptr RemoveChild (XmlNode::Ptr child) override
 Removes the specified XML node from the list of children of the XML document represented by the current object. More...
 
SharedPtr< XmlNodeListSelectNodes (String xpath) override
 Returns a list of XML nodes that match the specfied XPath expression. More...
 
SharedPtr< XmlNodeListSelectNodes (String xpath, SharedPtr< XmlNamespaceManager > nsmgr) override
 Returns a list of XML nodes that match the specfied XPath expression; any prefixes encountered in xpath expression are resolved using the specified namespace manager. More...
 
SharedPtr< XmlNodeSelectSingleNode (String xpath, SharedPtr< XmlNamespaceManager > nsmgr=nullptr) override
 Returns the first XML node that match the specfied XPath expression; any prefixes encountered in xpath expression are resolved using the specified namespace manager. More...
 
SharedPtr< XmlNodeListGetElementsByTagName (const String &name)
 Returns a list of XmlNode objects representing the XML elements whose qualified name matches the specifed value. More...
 
SharedPtr< XmlNodeListGetElementsByTagName (const String &localName, const String &namespaceURI)
 Returns a list of XmlNode objects representing the XML elements whose local name and namespace URI match the specifed values. More...
 
SharedPtr< XmlElementGetElementById (const String &elementId)
 NOT IMPLEMENTED. More...
 
SharedPtr< XPath::XPathNavigatorCreateNavigator () override
 Creates an instance of XPath::XPathNavigator class for navigating an XML document represented by the current object. More...
 
virtual XmlNode::Ptr CloneNode (bool deep) override
 NOT IMPLEMENTED. More...
 
xmlDoc * native_doc () const
 Retirns a pointer to the underlying xmlDoc object. More...
 
void set_XmlResolver (const SharedPtr< XmlResolver > &value)
 Sets the XML Resolver object used to access external XML documents. More...
 
void set_Schemas (const SharedPtr< Schema::XmlSchemaSet > &value)
 
virtual XmlNode::Ptr ReadNode (const SharedPtr< XmlReader > reader)
 Reads node from XmlReader. More...
 
void SetBaseURI (const String &base_uri)
 
- Public Member Functions inherited from System::Xml::XmlNode
virtual XmlNodeType get_NodeType () const
 Returns the type of the XML node represented by the current object. More...
 
virtual String get_LocalName () const
 Returns the local name of the XML node represented by the current object. More...
 
virtual String get_Prefix () const
 Returns the prefix of the XML node represented by the current object. More...
 
virtual String get_NamespaceURI () const
 Returns the namespace URI of the XML node represented by the current object. More...
 
virtual String get_InnerText () const
 Returns the concatenated values of the XML node represented by the current object and all its child nodes. More...
 
virtual String get_InnerXml () const
 Returns the XML markup representing the child nodes of the XML node represented by the current object. More...
 
virtual bool get_HasChildNodes () const
 Determines if the XML node represented by the current object has child nodes. More...
 
virtual SharedPtr< XmlAttributeCollectionget_Attributes ()
 Returns an XmlAttributeCollection object containing all attributes of the XML node represented by the current object. More...
 
virtual SharedPtr< XmlNodeListget_ChildNodes ()
 Returns an XmlNodeList object containing all child nodes of the XML node represented by the current object. More...
 
virtual SharedPtr< Schema::IXmlSchemaInfoget_SchemaInfo ()
 
virtual void set_Value (String value)
 Sets the value of the node represented by the current object. More...
 
virtual void set_Prefix (String)
 Sets the prefix of the XML node represented by the current object. More...
 
virtual void set_InnerXml (String value)
 Replaces the XML node's inner XML markup with the contents of the specified string. More...
 
virtual SharedPtr< XmlElementoperator[] (String name) const
 Returns a shared pointer to the XmlElement object representing the child element of the XML node represented by the current object with the specified qualified name. More...
 
virtual XmlNode::Ptr ReplaceChild (XmlNode::Ptr new_child, XmlNode::Ptr old_child)
 Replaces the specified the specified child node of the node reprsented by the current object with another one. More...
 
virtual void RemoveAll ()
 Removes all child nodes of the XML node reprsented by the current object. More...
 
virtual String GetPrefixOfNamespace (const String &namespace_uri)
 Looks up the closest xmlns declaration for the specified namespace URI that is in scope for the XML node represented by the current object and returns the prefix defined in that declaration. More...
 
virtual String GetNamespaceOfPrefix (const String &prefix)
 Looks up the closest xmlns declaration for the specified prefix that is in scope for the XML node represented by the current object and returns the namespace URI defined in that declaration. More...
 
virtual XmlNode::Ptr SelectSingleNode (String xPath)
 Returns the first XML node that match the specfied XPath expression. More...
 
SharedPtr< System::Collections::Generic::IEnumerator< XmlNode::Ptr > > GetEnumerator ()
 Returns an enumerator that points to the collection containing child nodes of the node represented by the current object. More...
 
XmlNode::Ptr Clone ()
 Returns a copy of the node represented by the current object. The subtree under the node is also copied. This method is equivallent to calling CloneNode(true). More...
 
xmlNode * native_node ()
 Returns a pointer to the underlying libxml2 xmlNode object. 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. Not implemented. 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...
 

Public Attributes

XmlNodeChangedEventSignal NodeInserting
 An event that is triggered when an XML node belonging to the XML document represented by the current object is about to be inserted into another XML node. More...
 
XmlNodeChangedEventSignal NodeInserted
 An event that is triggered when an XML node belonging to the XML document represented by the current object has been inserted into another XML node. More...
 
XmlNodeChangedEventSignal NodeRemoving
 An event that is triggered when an XML node belonging to the XML document represented by the current object is about to be removed from the list of children of its parent node. More...
 
XmlNodeChangedEventSignal NodeRemoved
 An event that is triggered when an XML node belonging to the XML document represented by the current object has been removed from the list of children of its parent node. More...
 
XmlNodeChangedEventSignal NodeChanging
 An event that is triggered when the value of the XML node belonging to the XML document represented by the current object is about to be modified. More...
 
XmlNodeChangedEventSignal NodeChanged
 An event that is triggered when the value of the XML node belonging to the XML document represented by the current object hes been modified. More...
 

Protected Member Functions

 ~XmlDocument () override
 Destructor. More...
 
void onNodeInserting (const XmlNode::Ptr &node, const XmlNode::Ptr &newParent)
 Triggers NodeInserting event. More...
 
void onNodeInserted (const XmlNode::Ptr &node, const XmlNode::Ptr &newParent)
 Triggers NodeInserted event. More...
 
void onNodeRemoving (const XmlNode::Ptr &node, const XmlNode::Ptr &oldParent)
 Triggers NodeRemoving event. More...
 
void onNodeRemoved (const XmlNode::Ptr &node, const XmlNode::Ptr &oldParent)
 Triggers NodeRemoved event. More...
 
void onNodeChanging (const XmlNode::Ptr &node, const XmlNode::Ptr &parent, const String &oldValue, const String &newValue)
 Triggers NodeChanging event. More...
 
void onNodeChanged (const XmlNode::Ptr &node, const XmlNode::Ptr &parent, const String &oldValue, const String &newValue)
 Triggers NodeChanged event. More...
 
SharedPtr< XmlAttributeCreateAttributeWithValue (const String &qname, const String &value)
 Creates an XML attribute with the specified qualified name and value. More...
 
- Protected Member Functions inherited from System::Xml::XmlNode
 ~XmlNode () override
 Destructor. More...
 
 XmlNode (xmlNode *node)
 Constructs an instance of XmlNode class that represents the specified XML node. More...
 
 XmlNode (xmlNode *node, const SharedPtr< XmlDocument > &owner)
 Constructs an instance of XmlNode class that represents the specified XML node and belongs to the specified owner XML document. More...
 
 XmlNode (const SharedPtr< XmlDocument > &owner)
 Constructs an instance of XmlNode class that belongs to the specified document. The underlying libxml2 xmlNode object is not created. This constructor is intended to be used by XmlDeclaration class only. More...
 
SharedPtr< XmlElementfind_child_xml_element_by_name (const String &name, const SharedPtr< XmlDocument > &owner_doc) const
 Looks up an XML element with the specified name which is a descandant of the specified XML document. More...
 
uint64_t child_elements_count () const
 Returns the number of children of all levels of the XML node represented by the current object. More...
 
bool can_be_append (XmlNodeType type) const
 Determines if an XML node of the specified type can be added as a child node to the XML node represented by the current object. More...
 
insert_where noralize_place (xmlNode *ref_child, insert_where place)
 Normalizes the indicator of the position where the node is to be inserted by making it consistent with the reference child value and presence of nodes in the list of children of the current node. More...
 
void insert_verified_child_node (const XmlNode::Ptr &child, xmlNode *ref_child, insert_where place)
 Inserts the specified node in the list of children of the node represented by the current object at the specified position. More...
 
void insert_document_fragment (const XmlNode::Ptr &fragment, xmlNode *ref_child, insert_where place)
 Inserts the nodes of the specified document fragment in the list of children of the node represented by the current object at the specified position. More...
 
void reassign_native (xmlNode *node)
 Replaces the node reprsented by the current object with the specified one. More...
 
xmlAttr * get_attribute_by_qname (const String &qname) const
 Returns an attribute with the specified qualified name. More...
 
xmlNs * find_ns (const std::string &prefix) const
 Returns a namespace associated with the specified prefix. More...
 
void set_Value (const String &text, bool riseEvent)
 Sets the value of the XML node represented by the current object and triggers corresponding events. More...
 

Protected Attributes

NameTable::Ptr m_nameTable
 The nametable used by the current object. More...
 
XmlDeclaration::Ptr m_xmlDeclarationNode
 XML declaration node of the XML document represented by the current object. More...
 
bool m_preserveWhitespace
 The flag indicating whether to preserve insignificant white spaces. More...
 
- Protected Attributes inherited from System::Xml::XmlNode
std::shared_ptr< xmlDoc > m_doc
 XML document to which the XML node represented by the current object belongs. More...
 
xmlNode * m_node
 Pointer to underlying libxml2 xmlNode object. More...
 
WeakPtr< XmlDocumentm_owner
 Weak poiter to the owning XML document. 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...
 
- Protected Types inherited from System::Xml::XmlNode
enum  insert_where { insert_begin , insert_before , insert_after , insert_end }
 Specifies the position in the child nodes list where to insert a node during insertion operation. More...
 
- Static Protected Member Functions inherited from System::Xml::XmlNode
static xmlNs * make_new_ns (xmlNodePtr parent, const std::string &prefix, const std::string &uri="")
 Creates a new namespace. More...
 
static void parse_qname (const std::string &qname, std::string &prefix, std::string &local_name)
 Parses the XML node's qualified name by breaking it into a prefix and a local name. More...
 
static int csharp_nodetype_to_libxml (XmlNodeType type)
 Converts the specified XML node type represented as an XmlNodeType value to equivalent value defied by libxml2 library. More...
 
static XmlNode::Ptr create_wrapper (xmlNode *node, const SharedPtr< XmlDocument > &owner, const std::shared_ptr< xmlDoc > &doc=nullptr)
 Creates an instance of XmlNode class that represents the specified node and belongs to the specified document. More...
 
static SharedPtr< XmlAttributecreate_wrapper_attr (xmlAttr *attr, const SharedPtr< XmlDocument > &owner)
 Creates an instance of XmlAttribute class that represents the specified attribute and belongs to the specified document. More...
 
static SharedPtr< XmlAttributecreate_wrapper_attr (xmlNs *ns, const SharedPtr< XmlDocument > &owner, const SharedPtr< XmlElement > &element)
 Creates an instance of XmlAttribute class that represents an xmlns attribute and belongs to the specified document. More...
 
static SharedPtr< XmlAttributecreate_wrapper_attr (const String &prefix, const String &local_name, const String &namespace_uri, const SharedPtr< XmlDocument > &owner)
 Constructs an XmlAttribute object that represents a detached XML attribute belonging to the specified owner. More...
 
template<typename T >
static SharedPtr< T > create_aliasing_wrapper (const SharedPtr< T > &ptr, const SharedPtr< XmlDocument > &document)
 Creates a shared pointer for pointee to an XML-node with aliasing constructor to own a document. More...
 

Detailed Description

Represents an XML document. Objects of this class should only be allocated using System::MakeObject() function. Never create instance 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 ( )

Default constructor. Constructs a new instance of XmlDocument class.

◆ XmlDocument() [2/3]

System::Xml::XmlDocument::XmlDocument ( xmlDoc *  native)

Constructs a new instance of XmlDocument class that represents the specified XML document.

Parameters
nativeAn instance of xmlDoc to be represented by the object being constructed

◆ XmlDocument() [3/3]

System::Xml::XmlDocument::XmlDocument ( const XmlNameTable::Ptr nameTable)

Constructs a new instance of XmlDocument class that uses the specified.

Parameters
nameTableThe name table to be associated with the object being constructed

◆ ~XmlDocument()

System::Xml::XmlDocument::~XmlDocument ( )
overrideprotected

Destructor.

Member Function Documentation

◆ AppendChild()

XmlNode::Ptr System::Xml::XmlDocument::AppendChild ( XmlNode::Ptr  child)
overridevirtual

Adds the specified XML node at the end of the list of children of the XML document represented by the current object.

Parameters
childThe XML node to add
Returns
A shared pointer to the specified XmlNode object child

Reimplemented from System::Xml::XmlNode.

◆ CloneNode()

virtual XmlNode::Ptr System::Xml::XmlDocument::CloneNode ( bool  deep)
overridevirtual

NOT IMPLEMENTED.

Exceptions
NotImplementedExceptionAlways

Implements System::Xml::XmlNode.

◆ CreateAttribute() [1/3]

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

Creates an attribute with the specified name.

Parameters
nameThe attribute's qualified name
Returns
A shared pointer to the created XmlAttribute object

◆ CreateAttribute() [2/3]

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

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

Parameters
prefixThe attribute's prefix
localNameThe attribute's local name
namespaceURIThe attribute's namespace URI
Returns
A shared pointer to the created XmlAttribute object

◆ CreateAttribute() [3/3]

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

Creates an attribute with the specified qualified name and namespace URI.

Parameters
qualifiedNameThe attribute's qualified name
namespaceURIThe attribute's namespace URI
Returns
A shared pointer to the created XmlAttribute object

◆ CreateAttributeWithValue()

SharedPtr<XmlAttribute> System::Xml::XmlDocument::CreateAttributeWithValue ( const String qname,
const String value 
)
protected

Creates an XML attribute with the specified qualified name and value.

Parameters
qnameThe attribute's qualified name
valueThe attribute's value
Returns
A shared pointer to the created XmlAttribute object

◆ CreateCDataSection()

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

Creates an XmlCDataSection object representing an XML CDATA section node with the specified content.

Parameters
dataThe content of the XML CDATA section node
Returns
A shared pointer to the created XmlCDataSection object

◆ CreateComment()

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

Creates an XmlComment object representing an XML comment node with the specified content.

Parameters
textThe content of the XML comment node
Returns
A shared pointer to the created XmlComment object

◆ CreateDefaultAttribute()

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

Creates attribute with default value.

Parameters
prefixAttribute prefix.
localNameAttribute name.
namespaceURIAttribute namespace URI.
Returns
A shared pointer to the created object.

◆ CreateDocumentFragment()

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

Creates an XmlDocumentFragment object.

Returns
A shared pointer to the created XmlDocumentFragment object

◆ CreateElement() [1/3]

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

Creates an XmlElement object representing an XML element with the specified prefix, local name and namespace URI.

Parameters
prefixThe element's prefix
localNameThe element's local name
namespaceURIThe element's namespace URI
Returns
A shared pointer to the created XmlElement object

◆ CreateElement() [2/3]

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

Creates an XmlElement object representing an XML element with the specified qualified name.

Parameters
qnameThe element's qualified name
Returns
A shared pointer to the created XmlElement object

◆ CreateElement() [3/3]

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

Creates an XmlElement object representing an XML element with the specified qualified name and namespace URI.

Parameters
qualifiedNameThe element's qualified name
namespaceURIThe elements's namespace URI
Returns
A shared pointer to the created XmlElement object

◆ CreateNavigator()

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

Creates an instance of XPath::XPathNavigator class for navigating an XML document represented by the current object.

Reimplemented from System::Xml::XmlNode.

◆ CreateNode()

SharedPtr<XmlNode> System::Xml::XmlDocument::CreateNode ( XmlNodeType  type,
const String qname,
const String namespaceURI = u"" 
)

Creates an XmlNode object representing an XML node of the specified type with the specified qualified name and namespace URI.

Parameters
typeThy type of the node to create
qnameThe node's qualified name
namespaceURIThe node's namespace URI
Returns
A shared pointer to the created XmlNode object

◆ CreateProcessingInstruction()

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

Creates an XmlProcessingInstruction object representing an XML processing instruction node with the specified values of 'target' and 'data' attributes.

Parameters
targetThe value of 'target' attribute of the XML processing instruction node represented by the object being constructed
dataThe value of 'data' attribute of the XML processing instruction node represented by the object being constructed
Returns
A shared pointer to the created XmlProcessingInstruction object

◆ CreateSignificantWhitespace()

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

Creates an XmlSignificantWhitespace object.

Parameters
textWhitespace text.
Returns
A shared pointer to the created object.

◆ CreateTextNode()

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

Creates an XmlText object representing an XML text node with the specified content.

Parameters
textThe content of the XML text node
Returns
A shared pointer to the created XmlText object

◆ CreateWhitespace()

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

Creates an XmlWhitespace object.

Parameters
textWhitespace text.
Returns
A shared pointer to the created object.

◆ CreateXmlDeclaration()

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

Creates an XmlDeclaration object representing an XML declaration node with the specified values of 'version', 'encoding' and 'standalone' attributes.

Parameters
versionThe value of 'version' attribute of the XML declaration node represented by the object being constructed
encodingThe value of 'encoding' attribute of the XML declaration node represented by the object being constructed
standaloneThe value of 'standalone' attribute of the XML declaration node represented by the object being constructed
Returns
A shared pointer to the created XmlDeclaration object

◆ get_BaseURI()

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

Gets the base URI of the current document.

Returns
The base URI string

Reimplemented from System::Xml::XmlNode.

◆ get_DocumentElement()

XmlElement::Ptr System::Xml::XmlDocument::get_DocumentElement ( )

Returns the root XmlElement of the XML document node represented by the current object.

◆ get_DocumentType()

XmlDocumentType::Ptr System::Xml::XmlDocument::get_DocumentType ( ) const

Gets the node containing the DOCTYPE declaration.

◆ get_FirstChild()

XmlNode::Ptr System::Xml::XmlDocument::get_FirstChild ( ) const
overridevirtual

Returns the first child of the node represented by the current object.

Reimplemented from System::Xml::XmlNode.

◆ get_LastChild()

XmlNode::Ptr System::Xml::XmlDocument::get_LastChild ( ) const
overridevirtual

Returns the last child of the node represented by the current object.

Reimplemented from System::Xml::XmlNode.

◆ get_Name()

String System::Xml::XmlDocument::get_Name ( ) const
inlineoverridevirtual

Returns the name of the node represented by the current object.

Implements System::Xml::XmlNode.

◆ get_NameTable()

XmlNameTable::Ptr System::Xml::XmlDocument::get_NameTable ( )
inline

Returns the XmlNameTable object associated with the current object.

◆ get_NextSibling()

XmlNode::Ptr System::Xml::XmlDocument::get_NextSibling ( ) const
overridevirtual

Returns the next sibling of the node represented by the current object.

Returns
Null-pointer

Reimplemented from System::Xml::XmlNode.

◆ get_OuterXml()

String System::Xml::XmlDocument::get_OuterXml ( ) const
overridevirtual

Returns the XML markup of the XML node represented by the current object and all its child nodes.

Reimplemented from System::Xml::XmlNode.

◆ get_OwnerDocument()

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

Returns a shared pointer to an XmlDocument object representing an XML document node to which the node represented by the current object belongs.

Returns
Null-pointer

Reimplemented from System::Xml::XmlNode.

◆ get_ParentNode()

XmlNode::Ptr System::Xml::XmlDocument::get_ParentNode ( ) const
overridevirtual

Returns the parent node of the node represented by the current object.

Returns
Null-pointer

Reimplemented from System::Xml::XmlNode.

◆ get_PreserveWhitespace()

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

Returns a value indicating whether to preserve insignificant white spaces in XML content.

◆ get_PreviousSibling()

XmlNode::Ptr System::Xml::XmlDocument::get_PreviousSibling ( ) const
overridevirtual

Returns the previous sibling of the node represented by the current object.

Returns
Null-pointer

Reimplemented from System::Xml::XmlNode.

◆ get_Value()

String System::Xml::XmlDocument::get_Value ( ) const
inlineoverridevirtual

Returns the value of the XML node represented by the current object.

Returns
An empty string

Reimplemented from System::Xml::XmlNode.

◆ GetElementById()

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

NOT IMPLEMENTED.

Exceptions
NotImplementedException

◆ GetElementsByTagName() [1/2]

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

Returns a list of XmlNode objects representing the XML elements whose local name and namespace URI match the specifed values.

Parameters
localNameThe string to match the XML elements' local names against
namespaceURIThe string to match the XML elements' namespace URI against
Returns
A list of XmlNode objects representing all document's descendant XML elements whose local names match localName and namespace URIs match namespace URI

◆ GetElementsByTagName() [2/2]

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

Returns a list of XmlNode objects representing the XML elements whose qualified name matches the specifed value.

Parameters
nameThe string to match the XML elements' names against
Returns
A list of XmlNode objects representing all document's descendant XML elements whose name matches name

◆ idx_get()

XmlElement::Ptr System::Xml::XmlDocument::idx_get ( String  name) const
overridevirtual

Returns an XmlElement object representing an XML element with the specified name which is a child of the node represented by the current object.

Reimplemented from System::Xml::XmlNode.

◆ ImportNode()

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

Imports the specified XML node from another XML document.

Parameters
nodeThe node to import
deepSpecifies whether to perform deep clone of the node (true) or not (false)

◆ InsertAfter()

XmlNode::Ptr System::Xml::XmlDocument::InsertAfter ( XmlNode::Ptr  child,
XmlNode::Ptr  ref_child 
)
overridevirtual

Adds the specified XML node to the list of children of the XML document represented by the current object at the position next to the position of the specified reference child node.

Parameters
childThe XML node to add
ref_childThe reference node indicating the position in the list of children next to which node should be inserted
Returns
A shared pointer to the specified XmlNode object child

Reimplemented from System::Xml::XmlNode.

◆ InsertBefore()

XmlNode::Ptr System::Xml::XmlDocument::InsertBefore ( XmlNode::Ptr  child,
XmlNode::Ptr  ref_child 
)
overridevirtual

Adds the specified XML node to the list of children of the XML document represented by the current object at the position prior to the position of the specified reference child node.

Parameters
childThe XML node to add
ref_childThe reference node indicating the position in the list of children prior to which node should be inserted
Returns
A shared pointer to the specified XmlNode object child

Reimplemented from System::Xml::XmlNode.

◆ Load() [1/4]

void System::Xml::XmlDocument::Load ( const SharedPtr< System::IO::Stream > &  stream)

Loads an XML document from the specified stream.

Parameters
streamThe stream to load the XML document from

◆ Load() [2/4]

void System::Xml::XmlDocument::Load ( const SharedPtr< System::IO::TextReader > &  reader)

Loads an XML document from the specified TextReader object.

Parameters
readerThe TextReader object to load the XML document from

◆ Load() [3/4]

void System::Xml::XmlDocument::Load ( const SharedPtr< XmlReader > &  reader)

Loads an XML document from the specified XmlReader object.

Parameters
readerThe XmlReader object to load the XML document from

◆ Load() [4/4]

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

Loads an XML document from the specified URL; URL can be a file or an HTTP URL.

Parameters
filenameThe URL

◆ LoadXml()

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

Loads an XML document from the specified string.

Parameters
xmlThe string containing an XML document to load

◆ native_doc()

xmlDoc* System::Xml::XmlDocument::native_doc ( ) const
inline

Retirns a pointer to the underlying xmlDoc object.

◆ onNodeChanged()

void System::Xml::XmlDocument::onNodeChanged ( const XmlNode::Ptr node,
const XmlNode::Ptr parent,
const String oldValue,
const String newValue 
)
protected

Triggers NodeChanged event.

Parameters
nodeThe XML node whose value has been changed
parentThe parent node of node
oldValueThe value that the node had before the change
newValueThe current value of node

◆ onNodeChanging()

void System::Xml::XmlDocument::onNodeChanging ( const XmlNode::Ptr node,
const XmlNode::Ptr parent,
const String oldValue,
const String newValue 
)
protected

Triggers NodeChanging event.

Parameters
nodeThe XML node whose value is about to be changed
parentThe parent node of node
oldValueThe current value of the node node
newValueThe value that is about to be set

◆ onNodeInserted()

void System::Xml::XmlDocument::onNodeInserted ( const XmlNode::Ptr node,
const XmlNode::Ptr newParent 
)
protected

Triggers NodeInserted event.

Parameters
nodeThe XML node that has been inserted
newParentThe XML node that has become a new parent node for node

◆ onNodeInserting()

void System::Xml::XmlDocument::onNodeInserting ( const XmlNode::Ptr node,
const XmlNode::Ptr newParent 
)
protected

Triggers NodeInserting event.

Parameters
nodeThe XML node that is about to be inserted
newParentThe XML node that is about to become a new parent node for node

◆ onNodeRemoved()

void System::Xml::XmlDocument::onNodeRemoved ( const XmlNode::Ptr node,
const XmlNode::Ptr oldParent 
)
protected

Triggers NodeRemoved event.

Parameters
nodeThe XML node that has been removed
oldParentThe XML node from the children list of which node has been removed

◆ onNodeRemoving()

void System::Xml::XmlDocument::onNodeRemoving ( const XmlNode::Ptr node,
const XmlNode::Ptr oldParent 
)
protected

Triggers NodeRemoving event.

Parameters
nodeThe XML node that is about to be removed
oldParentThe XML node from the children list of which node is about to be removed

◆ PrependChild()

XmlNode::Ptr System::Xml::XmlDocument::PrependChild ( XmlNode::Ptr  child)
overridevirtual

Adds the specified XML node at the beginning of the list of children of the XML document represented by the current object.

Parameters
childThe XML node to add
Returns
A shared pointer to the specified XmlNode object child

Reimplemented from System::Xml::XmlNode.

◆ ReadNode()

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

Reads node from XmlReader.

Parameters
readerReader to read node from.
Returns
Pointer to the node that was read.

◆ RemoveChild()

XmlNode::Ptr System::Xml::XmlDocument::RemoveChild ( XmlNode::Ptr  child)
overridevirtual

Removes the specified XML node from the list of children of the XML document represented by the current object.

Parameters
childThe XML node to remove
Returns
A shared pointer to the specified XmlNode object child

Reimplemented from System::Xml::XmlNode.

◆ Save() [1/4]

void System::Xml::XmlDocument::Save ( const SharedPtr< System::IO::Stream > &  stream) const

Saves the XML document represented by the current object to the specified stream.

Parameters
streamA stream to save the XML document to

◆ Save() [2/4]

void System::Xml::XmlDocument::Save ( const SharedPtr< System::IO::TextWriter > &  writer) const

Saves the XML document represented by the current object to the specified TextWriter object.

Parameters
writerA TextWriter object to save the XML document to

◆ Save() [3/4]

void System::Xml::XmlDocument::Save ( const SharedPtr< XmlWriter > &  writer) const

Saves the XML document represented by the current object to the specified XmlWriter object.

Parameters
writerAn XmlWriter object to save the XML document to

◆ Save() [4/4]

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

Saves the XML document represented by the current object to the specified file.

Parameters
filenameA path to the file to save the XML document to

◆ SelectNodes() [1/2]

SharedPtr<XmlNodeList> System::Xml::XmlDocument::SelectNodes ( String  xpath)
inlineoverridevirtual

Returns a list of XML nodes that match the specfied XPath expression.

Parameters
xpathThe XPath expression
Returns
The list of XmlNode objects representing XML nodes that match xpath XPath expression

Reimplemented from System::Xml::XmlNode.

◆ SelectNodes() [2/2]

SharedPtr<XmlNodeList> System::Xml::XmlDocument::SelectNodes ( String  xpath,
SharedPtr< XmlNamespaceManager nsmgr 
)
inlineoverridevirtual

Returns a list of XML nodes that match the specfied XPath expression; any prefixes encountered in xpath expression are resolved using the specified namespace manager.

Parameters
xpathThe XPath expression
nsmgrThe XmlNamespaceManager object used to resolve prefixes found in xpath expression
Returns
The list of XmlNode objects representing XML nodes that match xpath XPath expression

Reimplemented from System::Xml::XmlNode.

◆ SelectSingleNode()

SharedPtr<XmlNode> System::Xml::XmlDocument::SelectSingleNode ( String  xpath,
SharedPtr< XmlNamespaceManager nsmgr = nullptr 
)
inlineoverridevirtual

Returns the first XML node that match the specfied XPath expression; any prefixes encountered in xpath expression are resolved using the specified namespace manager.

Parameters
xpathThe XPath expression
nsmgrThe XmlNamespaceManager object used to resolve prefixes found in xpath expression
Returns
An XmlNode object representing the first XML node that matched xpath XPath expression

Reimplemented from System::Xml::XmlNode.

◆ set_InnerText()

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

NOT APPLICABLE.

Exceptions
InvalidOperationExceptionAlways

Reimplemented from System::Xml::XmlNode.

◆ set_PreserveWhitespace()

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

Sets a value indicating whether to preserve insignificant white spaces in XML content.

◆ set_Schemas()

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

◆ set_XmlResolver()

void System::Xml::XmlDocument::set_XmlResolver ( const SharedPtr< XmlResolver > &  value)

Sets the XML Resolver object used to access external XML documents.

Parameters
valueThe XmlResolver object to set

◆ SetBaseURI()

void System::Xml::XmlDocument::SetBaseURI ( const String base_uri)

◆ Validate()

void System::Xml::XmlDocument::Validate ( const Schema::ValidationEventHandler event_handler)

◆ WriteContentTo()

virtual void System::Xml::XmlDocument::WriteContentTo ( SharedPtr< XmlWriter writer)
overridevirtual

Saves all children of the XML document node represented by the current object to the specified XmlWriter object.

Parameters
writerA XmlWriter object to save the chlid nodes to

Reimplemented from System::Xml::XmlNode.

◆ WriteTo()

virtual void System::Xml::XmlDocument::WriteTo ( SharedPtr< XmlWriter writer)
overridevirtual

Saves the XML document node represented by the current object to the specified XmlWriter object.

Parameters
writerA XmlWriter object to save the node to

Implements System::Xml::XmlNode.

Member Data Documentation

◆ m_nameTable

NameTable::Ptr System::Xml::XmlDocument::m_nameTable
protected

The nametable used by the current object.

◆ m_preserveWhitespace

bool System::Xml::XmlDocument::m_preserveWhitespace
protected

The flag indicating whether to preserve insignificant white spaces.

◆ m_xmlDeclarationNode

XmlDeclaration::Ptr System::Xml::XmlDocument::m_xmlDeclarationNode
protected

XML declaration node of the XML document represented by the current object.

◆ NodeChanged

XmlNodeChangedEventSignal System::Xml::XmlDocument::NodeChanged

An event that is triggered when the value of the XML node belonging to the XML document represented by the current object hes been modified.

◆ NodeChanging

XmlNodeChangedEventSignal System::Xml::XmlDocument::NodeChanging

An event that is triggered when the value of the XML node belonging to the XML document represented by the current object is about to be modified.

◆ NodeInserted

XmlNodeChangedEventSignal System::Xml::XmlDocument::NodeInserted

An event that is triggered when an XML node belonging to the XML document represented by the current object has been inserted into another XML node.

◆ NodeInserting

XmlNodeChangedEventSignal System::Xml::XmlDocument::NodeInserting

An event that is triggered when an XML node belonging to the XML document represented by the current object is about to be inserted into another XML node.

◆ NodeRemoved

XmlNodeChangedEventSignal System::Xml::XmlDocument::NodeRemoved

An event that is triggered when an XML node belonging to the XML document represented by the current object has been removed from the list of children of its parent node.

◆ NodeRemoving

XmlNodeChangedEventSignal System::Xml::XmlDocument::NodeRemoving

An event that is triggered when an XML node belonging to the XML document represented by the current object is about to be removed from the list of children of its parent node.