System::Xml::XmlDeclaration Class Reference

Inherits System::Xml::XmlLinkedNode.

Public Types

using Ptr = SharedPtr< XmlDeclaration >
 An alias for shared pointer to an instance of this class. More...
 
- Public Types inherited from System::Xml::XmlLinkedNode
using Ptr = SharedPtr< XmlLinkedNode >
 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

ASPOSECPP_SHARED_API String get_Version ()
 
ASPOSECPP_SHARED_API String get_Encoding ()
 
ASPOSECPP_SHARED_API void set_Encoding (const String &value)
 
ASPOSECPP_SHARED_API String get_Standalone ()
 
ASPOSECPP_SHARED_API void set_Standalone (const String &value)
 
ASPOSECPP_SHARED_API String get_Value () override
 
ASPOSECPP_SHARED_API void set_Value (String value) override
 
ASPOSECPP_SHARED_API String get_InnerText () override
 
ASPOSECPP_SHARED_API void set_InnerText (String value) override
 
ASPOSECPP_SHARED_API String get_Name () override
 
ASPOSECPP_SHARED_API String get_LocalName () override
 
ASPOSECPP_SHARED_API XmlNodeType get_NodeType () override
 
ASPOSECPP_SHARED_API SharedPtr< XmlNodeCloneNode (bool deep) override
 
ASPOSECPP_SHARED_API void WriteTo (const SharedPtr< XmlWriter > &w) override
 
ASPOSECPP_SHARED_API void WriteContentTo (const SharedPtr< XmlWriter > &w) override
 
- Public Member Functions inherited from System::Xml::XmlNode
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeget_ParentNode () final
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeListget_ChildNodes ()
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeget_PreviousSibling () final
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeget_NextSibling () final
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlAttributeCollectionget_Attributes () final
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlDocumentget_OwnerDocument ()
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeget_FirstChild () final
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeget_LastChild () final
 
virtual ASPOSECPP_SHARED_API bool get_HasChildNodes ()
 
virtual ASPOSECPP_SHARED_API String get_NamespaceURI ()
 
virtual ASPOSECPP_SHARED_API String get_Prefix ()
 
virtual ASPOSECPP_SHARED_API void set_Prefix (String value)
 
virtual ASPOSECPP_SHARED_API bool get_IsReadOnly ()
 
virtual ASPOSECPP_SHARED_API String get_OuterXml ()
 
virtual ASPOSECPP_SHARED_API String get_InnerXml ()
 
virtual ASPOSECPP_SHARED_API void set_InnerXml (String value)
 
virtual ASPOSECPP_SHARED_API SharedPtr< Schema::IXmlSchemaInfoget_SchemaInfo ()
 
virtual ASPOSECPP_SHARED_API String get_BaseURI ()
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeget_PreviousText ()
 
ASPOSECPP_SHARED_API SharedPtr< XPath::XPathNavigatorCreateNavigator () override
 
ASPOSECPP_SHARED_API SharedPtr< XmlNodeSelectSingleNode (const String &xpath)
 
ASPOSECPP_SHARED_API SharedPtr< XmlNodeSelectSingleNode (const String &xpath, const SharedPtr< XmlNamespaceManager > &nsmgr)
 
ASPOSECPP_SHARED_API SharedPtr< XmlNodeListSelectNodes (const String &xpath)
 
ASPOSECPP_SHARED_API SharedPtr< XmlNodeListSelectNodes (const String &xpath, const SharedPtr< XmlNamespaceManager > &nsmgr)
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeInsertBefore (SharedPtr< XmlNode > newChild, SharedPtr< XmlNode > refChild)
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeInsertAfter (SharedPtr< XmlNode > newChild, SharedPtr< XmlNode > refChild)
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeReplaceChild (SharedPtr< XmlNode > newChild, SharedPtr< XmlNode > oldChild)
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeRemoveChild (SharedPtr< XmlNode > oldChild)
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodePrependChild (SharedPtr< XmlNode > newChild)
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeAppendChild (SharedPtr< XmlNode > newChild)
 
virtual ASPOSECPP_SHARED_API void Normalize ()
 
virtual ASPOSECPP_SHARED_API bool Supports (String feature, String version)
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlNodeClone ()
 
ASPOSECPP_SHARED_API SharedPtr< Collections::Generic::IEnumerator< SharedPtr< XmlNode > > > GetEnumerator () override
 
virtual ASPOSECPP_SHARED_API void RemoveAll ()
 Removes all the child nodes and/or attributes of the current node. More...
 
virtual ASPOSECPP_SHARED_API String GetNamespaceOfPrefix (String prefix)
 
virtual ASPOSECPP_SHARED_API String GetPrefixOfNamespace (String namespaceURI)
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlElementidx_get (String name)
 
virtual ASPOSECPP_SHARED_API SharedPtr< XmlElementidx_get (String localname, String ns)
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< SharedPtr< System::Xml::XmlNode > >
SharedPtr< System::Xml::XmlNodeLINQ_ElementAt (int index)
 
SharedPtr< System::Xml::XmlNodeLINQ_First ()
 
SharedPtr< System::Xml::XmlNodeLINQ_First (const Func< SharedPtr< System::Xml::XmlNode >, bool > &predicate)
 
SharedPtr< System::Xml::XmlNodeLINQ_FirstOrDefault ()
 
SharedPtr< System::Xml::XmlNodeLINQ_FirstOrDefault (std::function< bool(SharedPtr< System::Xml::XmlNode >)> predicate)
 
SharedPtr< System::Xml::XmlNodeLINQ_Last ()
 
SharedPtr< System::Xml::XmlNodeLINQ_LastOrDefault ()
 
SharedPtr< List< SharedPtr< System::Xml::XmlNode > > > LINQ_ToList ()
 
int LINQ_Count ()
 
int LINQ_Count (const Func< SharedPtr< System::Xml::XmlNode >, bool > &predicate)
 
System::ArrayPtr< SharedPtr< System::Xml::XmlNode > > LINQ_ToArray ()
 
bool LINQ_All (std::function< bool(SharedPtr< System::Xml::XmlNode >)> predicate)
 
bool LINQ_Any ()
 
bool LINQ_Any (std::function< bool(SharedPtr< System::Xml::XmlNode >)> predicate)
 
SharedPtr< IEnumerable< SharedPtr< System::Xml::XmlNode > > > LINQ_Where (std::function< bool(SharedPtr< System::Xml::XmlNode >)> predicate)
 
bool LINQ_Contains (SharedPtr< System::Xml::XmlNode > value)
 
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
SharedPtr< IEnumerable< SharedPtr< System::Xml::XmlNode > > > LINQ_OrderBy (const Func< SharedPtr< System::Xml::XmlNode >, Key > &keySelector)
 
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)
 
SharedPtr< IEnumerable< Source > > LINQ_OrderByDescending (const Func< Source, Key > &keySelector)
 
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< SharedPtr< System::Xml::XmlNode >, ResultType > &selector)
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< SharedPtr< System::Xml::XmlNode >, int32_t, ResultType > &selector)
 
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)
 
System::SharedPtr< IEnumerable< System::SharedPtr< System::Linq::IGrouping< Key, SharedPtr< System::Xml::XmlNode > > > > > LINQ_GroupBy (System::Func< SharedPtr< System::Xml::XmlNode >, Key > keyPredicate)
 
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)
 
SharedPtr< IEnumerable< Result > > LINQ_SelectMany (const Func< Source, SharedPtr< IEnumerable< Result >>> &selector)
 
iterator begin ()
 
const_iterator begin () const
 
iterator end ()
 
const_iterator end () const
 
const_iterator cbegin () const
 
const_iterator cend () const
 
virtual virtualized_iteratorvirtualizeBeginIterator ()
 
virtual virtualized_iteratorvirtualizeEndIterator ()
 
virtual virtualized_iteratorvirtualizeBeginConstIterator () const
 
virtual virtualized_iteratorvirtualizeEndConstIterator () const
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
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)
 

Additional Inherited Members

- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

Represents the XML declaration node <?xml version='1.0'...?>.

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.

Member Function Documentation

◆ CloneNode()

ASPOSECPP_SHARED_API SharedPtr<XmlNode> System::Xml::XmlDeclaration::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. Because XmlDeclaration nodes do not have children, the cloned node always includes the data value, regardless of the parameter setting.
Returns
The cloned node.

Implements System::Xml::XmlNode.

◆ get_Encoding()

ASPOSECPP_SHARED_API String System::Xml::XmlDeclaration::get_Encoding ( )

Returns the encoding level of the XML document.

Returns
The valid character encoding name.

The most commonly supported character encoding names for XML are the following:

Category Encoding Names
Unicode UTF-8, UTF-16
ISO 10646 ISO-10646-UCS-2, ISO-10646-UCS-4
ISO 8859 ISO-8859-n (where "n" is a digit from 1 to 9)
JIS X-0208-1997 ISO-2022-JP, Shift_JIS, EUC-JP

This value is optional. If a value is not set, this method returns String::Empty. If an encoding attribute is not included, UTF-8 encoding is assumed when the document is written or saved out.

◆ get_InnerText()

ASPOSECPP_SHARED_API String System::Xml::XmlDeclaration::get_InnerText ( )
overridevirtual

Returns the concatenated values of the XmlDeclaration.

Returns
The concatenated values of the XmlDeclaration (that is, everything between <?xml and ?>).

Reimplemented from System::Xml::XmlNode.

◆ get_LocalName()

ASPOSECPP_SHARED_API String System::Xml::XmlDeclaration::get_LocalName ( )
overridevirtual

Returns the local name of the node.

Returns
For XmlDeclaration nodes, the local name is xml.

Implements System::Xml::XmlNode.

◆ get_Name()

ASPOSECPP_SHARED_API String System::Xml::XmlDeclaration::get_Name ( )
overridevirtual

Returns the qualified name of the node.

Returns
For XmlDeclaration nodes, the name is xml.

Implements System::Xml::XmlNode.

◆ get_NodeType()

ASPOSECPP_SHARED_API XmlNodeType System::Xml::XmlDeclaration::get_NodeType ( )
overridevirtual

Returns the type of the current node.

Returns
For XmlDeclaration nodes, this value is XmlNodeType::XmlDeclaration.

Implements System::Xml::XmlNode.

◆ get_Standalone()

ASPOSECPP_SHARED_API String System::Xml::XmlDeclaration::get_Standalone ( )

Returns the value of the standalone attribute.

Returns
Valid values are yes if all entity declarations required by the XML document are contained within the document or no if an external document type definition (DTD) is required. If a standalone attribute is not present in the XML declaration, this method returns String::Empty.

◆ get_Value()

ASPOSECPP_SHARED_API String System::Xml::XmlDeclaration::get_Value ( )
overridevirtual

Returns the value of the XmlDeclaration.

Returns
The contents of the XmlDeclaration (that is, everything between <?xml and ?>).

Reimplemented from System::Xml::XmlNode.

◆ get_Version()

ASPOSECPP_SHARED_API String System::Xml::XmlDeclaration::get_Version ( )

Returns the XML version of the document.

Returns
The value is always 1.0.

◆ set_Encoding()

ASPOSECPP_SHARED_API void System::Xml::XmlDeclaration::set_Encoding ( const String value)

Sets the encoding level of the XML document.

Parameters
valueThe value to set.

◆ set_InnerText()

ASPOSECPP_SHARED_API void System::Xml::XmlDeclaration::set_InnerText ( String  value)
overridevirtual

Sets the concatenated values of the XmlDeclaration.

Parameters
valueThe value to set.

Reimplemented from System::Xml::XmlNode.

◆ set_Standalone()

ASPOSECPP_SHARED_API void System::Xml::XmlDeclaration::set_Standalone ( const String value)

Sets the value of the standalone attribute.

Parameters
valueThe value to set.

◆ set_Value()

ASPOSECPP_SHARED_API void System::Xml::XmlDeclaration::set_Value ( String  value)
overridevirtual

Sets the value of the XmlDeclaration.

Parameters
valueThe value to set.

Reimplemented from System::Xml::XmlNode.

◆ WriteContentTo()

ASPOSECPP_SHARED_API void System::Xml::XmlDeclaration::WriteContentTo ( const SharedPtr< XmlWriter > &  w)
overridevirtual

Saves the children of the node to the specified XmlWriter. Because XmlDeclaration nodes do not have children, this method has no effect.

Parameters
wThe XmlWriter to which you want to save.

Implements System::Xml::XmlNode.

◆ WriteTo()

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

Saves the node to the specified XmlWriter.

Parameters
wThe XmlWriter to which you want to save.

Implements System::Xml::XmlNode.