System::Xml::XmlCharacterData Class Referenceabstract

Inherits System::Xml::XmlNode.

Inherited by System::Xml::XmlCDataSection, System::Xml::XmlComment, and System::Xml::XmlText.

Public Member Functions

virtual ASPOSECPP_SHARED_API int get_Length () const =0
 Returns the length of the data in characters. More...
 
virtual String get_Data () const
 
virtual void set_Data (String value)
 Sets the content of the node represented by the current object. More...
 
virtual ASPOSECPP_SHARED_API void AppendData (String strData)
 Appends the specified string to the content of the node represented by the current object. More...
 
virtual ASPOSECPP_SHARED_API void DeleteData (int offset, int count)
 
virtual ASPOSECPP_SHARED_API void InsertData (int offset, String strData)
 
virtual ASPOSECPP_SHARED_API void ReplaceData (int offset, int count, String strData)
 
virtual ASPOSECPP_SHARED_API String Substring (int offset, int count)
 
ASPOSECPP_SHARED_API XmlNode::Ptr CloneNode (bool deep) override
 
- Public Member Functions inherited from System::Xml::XmlNode
virtual ASPOSECPP_SHARED_API ~XmlNode ()
 Destructor. More...
 
virtual ASPOSECPP_SHARED_API XmlNodeType get_NodeType () const
 Returns the type of the XML node represented by the current object. More...
 
virtual ASPOSECPP_SHARED_API String get_Name () const =0
 Returns the qualified name of the XML node represented by the current object. More...
 
virtual ASPOSECPP_SHARED_API String get_Value () const
 Returns the value of the XML node represented by the current object. More...
 
virtual ASPOSECPP_SHARED_API String get_LocalName () const
 Returns the local name of the XML node represented by the current object. More...
 
virtual ASPOSECPP_SHARED_API String get_Prefix () const
 Returns the prefix of the XML node represented by the current object. More...
 
virtual ASPOSECPP_SHARED_API String get_NamespaceURI () const
 Returns the namespace URI of the XML node represented by the current object. More...
 
virtual ASPOSECPP_SHARED_API String get_InnerText () const
 Returns the concatenated values of the XML node represented by the current object and all its child nodes. More...
 
virtual ASPOSECPP_SHARED_API String get_InnerXml () const
 Returns the XML markup representing the child nodes of the XML node represented by the current object. More...
 
virtual ASPOSECPP_SHARED_API String get_OuterXml () const
 Returns the XML markup representing the XML node represented by the current object and all its the child nodes. More...
 
virtual ASPOSECPP_SHARED_API bool get_HasChildNodes () const
 
virtual ASPOSECPP_SHARED_API XmlNode::Ptr get_FirstChild () const
 Returns the first child of the node represented by the current object. More...
 
virtual ASPOSECPP_SHARED_API XmlNode::Ptr get_LastChild () const
 Returns the last child of the node represented by the current object. More...
 
virtual ASPOSECPP_SHARED_API XmlNode::Ptr get_NextSibling () const
 Returns the next sibling of the node represented by the current object. More...
 
virtual ASPOSECPP_SHARED_API XmlNode::Ptr get_PreviousSibling () const
 Returns the previous sibling of the node represented by the current object. More...
 
virtual ASPOSECPP_SHARED_API XmlNode::Ptr get_ParentNode () const
 Returns the parent node of the node represented by the current object. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlDocumentget_OwnerDocument () const
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlAttributeCollectionget_Attributes ()
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeListget_ChildNodes ()
 
virtual ASPOSECPP_SHARED_API void set_Value (String value)
 
virtual void set_Prefix (String)
 Sets the prefix of the XML node represented by the current object. More...
 
virtual ASPOSECPP_SHARED_API void set_InnerText (String value)
 
virtual ASPOSECPP_SHARED_API void set_InnerXml (String value)
 
virtual SharedPtr< XmlElementidx_get (String) const
 Returns a shared pointer to the newly constructed XmlElement object. More...
 
virtual SharedPtr< XmlElementoperator[] (String name) const
 
virtual ASPOSECPP_SHARED_API XmlNode::Ptr AppendChild (XmlNode::Ptr child)
 
virtual ASPOSECPP_SHARED_API XmlNode::Ptr PrependChild (XmlNode::Ptr new_child)
 
virtual ASPOSECPP_SHARED_API XmlNode::Ptr ReplaceChild (XmlNode::Ptr new_child, XmlNode::Ptr old_child)
 
virtual ASPOSECPP_SHARED_API XmlNode::Ptr InsertAfter (XmlNode::Ptr new_child, XmlNode::Ptr ref_child)
 
virtual ASPOSECPP_SHARED_API XmlNode::Ptr InsertBefore (XmlNode::Ptr new_child, XmlNode::Ptr ref_child)
 
virtual ASPOSECPP_SHARED_API void RemoveAll ()
 Removes all child nodes of the XML node reprsented by the current object. More...
 
virtual ASPOSECPP_SHARED_API XmlNode::Ptr RemoveChild (XmlNode::Ptr child)
 
virtual ASPOSECPP_SHARED_API String GetPrefixOfNamespace (const String &namespace_uri)
 
virtual ASPOSECPP_SHARED_API String GetNamespaceOfPrefix (const String &prefix)
 
virtual void WriteContentTo (SharedPtr< XmlWriter > writer)
 
virtual ASPOSECPP_SHARED_API void WriteTo (SharedPtr< XmlWriter > writer)=0
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeListSelectNodes (String xPath)
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeListSelectNodes (String xPath, SharedPtr< XmlNamespaceManager > nsMgr)
 
virtual ASPOSECPP_SHARED_API XmlNode::Ptr SelectSingleNode (String xPath)
 
virtual ASPOSECPP_SHARED_API XmlNode::Ptr SelectSingleNode (String xPath, SharedPtr< XmlNamespaceManager > nsMgr)
 
ASPOSECPP_SHARED_API SharedPtr< System::Collections::Generic::IEnumerator< XmlNode::Ptr > > GetEnumerator ()
 
XmlNode::Ptr Clone ()
 
xmlNode * native_node ()
 Returns a pointer to the underlying libxml2 xmlNode object. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Protected Member Functions

ASPOSECPP_SHARED_API XmlCharacterData (xmlNode *node, const SharedPtr< XmlDocument > &owner)
 
- Protected Member Functions inherited from System::Xml::XmlNode
ASPOSECPP_SHARED_API XmlNode (xmlNode *node)
 
ASPOSECPP_SHARED_API XmlNode (xmlNode *node, const SharedPtr< XmlDocument > &owner)
 
ASPOSECPP_SHARED_API XmlNode (const SharedPtr< XmlDocument > &owner)
 
SharedPtr< XmlElementfind_child_xml_element_by_name (const String &name, const SharedPtr< XmlDocument > &owner_doc) const
 
uint64_t child_elements_count () const
 
bool can_be_append (XmlNodeType type) const
 
insert_where noralize_place (xmlNode *ref_child, insert_where place)
 
void insert_verified_child_node (const XmlNode::Ptr &child, xmlNode *ref_child, insert_where place)
 
void insert_document_fragment (const XmlNode::Ptr &fragment, xmlNode *ref_child, insert_where place)
 
void reassign_native (xmlNode *node)
 
xmlAttr * get_attribute_by_qname (const String &qname) const
 
xmlNs * find_ns (const std::string &prefix) const
 
ASPOSECPP_SHARED_API void set_Value (const String &text, bool riseEvent)
 

Additional Inherited Members

- 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...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 
- Protected Types inherited from System::Xml::XmlNode
enum  insert_where { insert_begin, insert_before, insert_after, insert_end }
 
- Static Protected Member Functions inherited from System::Xml::XmlNode
static xmlNs * make_new_ns (xmlNodePtr parent, const std::string &prefix, const std::string &uri="")
 
static void parse_qname (const std::string &qname, std::string &prefix, std::string &local_name)
 
static int csharp_nodetype_to_libxml (XmlNodeType type)
 
static XmlNode::Ptr create_wrapper (xmlNode *node, const SharedPtr< XmlDocument > &owner, const std::shared_ptr< xmlDoc > &doc=nullptr)
 
static SharedPtr< XmlAttributecreate_wrapper_attr (xmlAttr *attr, const SharedPtr< XmlDocument > &owner)
 
static SharedPtr< XmlAttributecreate_wrapper_attr (xmlNs *ns, const SharedPtr< XmlDocument > &owner, const SharedPtr< XmlElement > &element)
 
static SharedPtr< XmlAttributecreate_wrapper_attr (const String &prefix, const String &local_name, const String &namespace_uri, const SharedPtr< XmlDocument > &owner)
 
- Protected Attributes inherited from System::Xml::XmlNode
std::shared_ptr< xmlDoc > m_doc
 
xmlNode * m_node
 Pointer to underlying libxml2 xmlNode object. More...
 
WeakPtr< XmlDocumentm_owner
 Weak poiter to the owning XML document. More...
 

Detailed Description

Serves as a base class for several classes that represent XML nodes that represent sequences of characters. 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.

Constructor & Destructor Documentation

◆ XmlCharacterData()

ASPOSECPP_SHARED_API System::Xml::XmlCharacterData::XmlCharacterData ( xmlNode *  node,
const SharedPtr< XmlDocument > &  owner 
)
protected

Constructs an XmlCharacterData object that represents the specified native node and belongs to the specified XmlDocument.

Parameters
nodeThe node to be represented by the object being constructed
ownerThe XML document to which the object being constructed will belong

Member Function Documentation

◆ AppendData()

virtual ASPOSECPP_SHARED_API void System::Xml::XmlCharacterData::AppendData ( String  strData)
virtual

Appends the specified string to the content of the node represented by the current object.

◆ CloneNode()

ASPOSECPP_SHARED_API XmlNode::Ptr System::Xml::XmlCharacterData::CloneNode ( bool  deep)
overridevirtual

NOT IMPLEMENTED.

Exceptions
NotImplementedExceptionAlways

Implements System::Xml::XmlNode.

◆ DeleteData()

virtual ASPOSECPP_SHARED_API void System::Xml::XmlCharacterData::DeleteData ( int  offset,
int  count 
)
virtual

Removes the specified substring from the content of the node represented by the current object.

Parameters
offset0-based index of the character of the node's content string at which the substring to remove begins
countThe number of characters to remove

◆ get_Data()

virtual String System::Xml::XmlCharacterData::get_Data ( ) const
inlinevirtual

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

Returns
The content of the node represented by the current object.

Reimplemented in System::Xml::XmlCDataSection.

◆ get_Length()

virtual ASPOSECPP_SHARED_API int System::Xml::XmlCharacterData::get_Length ( ) const
pure virtual

Returns the length of the data in characters.

Implemented in System::Xml::XmlCDataSection, System::Xml::XmlText, and System::Xml::XmlComment.

◆ InsertData()

virtual ASPOSECPP_SHARED_API void System::Xml::XmlCharacterData::InsertData ( int  offset,
String  strData 
)
virtual

Insert the specified string at the specified position in the content string

Parameters
offset0-based index of the node's content string after which the specified string is inserted
strDataThe string to insert

◆ ReplaceData()

virtual ASPOSECPP_SHARED_API void System::Xml::XmlCharacterData::ReplaceData ( int  offset,
int  count,
String  strData 
)
virtual

Replaces the specified content string of the node represented by the current object with the specified string

Parameters
offset0-based index of the character of the node's content string at which the substring to remove begins
countThe length of the substring to replace
strDataThe string to replace the content substring with

◆ set_Data()

virtual void System::Xml::XmlCharacterData::set_Data ( String  value)
inlinevirtual

Sets the content of the node represented by the current object.

Reimplemented in System::Xml::XmlCDataSection.

◆ Substring()

virtual ASPOSECPP_SHARED_API String System::Xml::XmlCharacterData::Substring ( int  offset,
int  count 
)
virtual

Returns the specified substring of the node's content string.

Parameters
offset0-based index of the character of the node's content string at which the substring to return begins
countThe length of the substring to return
Returns
The specified content substring