Asposecpplib
System::Xml::XmlParserContext Class Reference

Provides all the context information required by the XmlReader to parse an XML fragment. More...

Inherits System::Object.

Public Types

using Ptr = SharedPtr< XmlParserContext >
 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

SharedPtr< XmlNameTableget_NameTable ()
 Returns the XmlNameTable used to atomize strings. For more information on atomized strings, see XmlNameTable. More...
 
void set_NameTable (const SharedPtr< XmlNameTable > &value)
 Sets the XmlNameTable used to atomize strings. For more information on atomized strings, see XmlNameTable. More...
 
SharedPtr< XmlNamespaceManagerget_NamespaceManager ()
 Returns the XmlNamespaceManager. More...
 
void set_NamespaceManager (const SharedPtr< XmlNamespaceManager > &value)
 Sets the XmlNamespaceManager. More...
 
String get_DocTypeName ()
 Returns the name of the document type declaration. More...
 
void set_DocTypeName (const String &value)
 Sets the name of the document type declaration. More...
 
String get_PublicId ()
 Returns the public identifier. More...
 
void set_PublicId (const String &value)
 Sets the public identifier. More...
 
String get_SystemId ()
 Returns the system identifier. More...
 
void set_SystemId (const String &value)
 Sets the system identifier. More...
 
String get_BaseURI ()
 Returns the base URI. More...
 
void set_BaseURI (const String &value)
 Sets the base URI. More...
 
String get_InternalSubset ()
 Returns the internal DTD subset. More...
 
void set_InternalSubset (const String &value)
 Sets the internal DTD subset. More...
 
String get_XmlLang ()
 Returns the current xml:lang scope. More...
 
void set_XmlLang (const String &value)
 Sets the current xml:lang scope. More...
 
System::Xml::XmlSpace get_XmlSpace ()
 Returns the current xml:space scope. More...
 
void set_XmlSpace (System::Xml::XmlSpace value)
 Sets the current xml:space scope. More...
 
SharedPtr< System::Text::Encodingget_Encoding ()
 Returns the encoding type. More...
 
void set_Encoding (const SharedPtr< System::Text::Encoding > &value)
 Sets the encoding type. More...
 
 XmlParserContext (const SharedPtr< XmlNameTable > &nt, const SharedPtr< XmlNamespaceManager > &nsMgr, const String &xmlLang, System::Xml::XmlSpace xmlSpace)
 Initializes a new instance of the XmlParserContext class with the specified XmlNameTable, XmlNamespaceManager, xml:lang, and xml:space values. More...
 
 XmlParserContext (const SharedPtr< XmlNameTable > &nt, const SharedPtr< XmlNamespaceManager > &nsMgr, const String &xmlLang, System::Xml::XmlSpace xmlSpace, const SharedPtr< System::Text::Encoding > &enc)
 Initializes a new instance of the XmlParserContext class with the specified XmlNameTable, XmlNamespaceManager, xml:lang, xml:space, and encoding. More...
 
 XmlParserContext (const SharedPtr< XmlNameTable > &nt, const SharedPtr< XmlNamespaceManager > &nsMgr, const String &docTypeName, const String &pubId, const String &sysId, const String &internalSubset, const String &baseURI, const String &xmlLang, System::Xml::XmlSpace xmlSpace)
 Initializes a new instance of the XmlParserContext class with the specified XmlNameTable, XmlNamespaceManager, base URI, xml:lang, xml:space, and document type values. More...
 
 XmlParserContext (const SharedPtr< XmlNameTable > &nt, const SharedPtr< XmlNamespaceManager > &nsMgr, const String &docTypeName, const String &pubId, const String &sysId, const String &internalSubset, const String &baseURI, const String &xmlLang, System::Xml::XmlSpace xmlSpace, const SharedPtr< System::Text::Encoding > &enc)
 Initializes a new instance of the XmlParserContext class with the specified XmlNameTable, XmlNamespaceManager, base URI, xml:lang, xml:space, encoding, and document type values. 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...
 

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

Provides all the context information required by the XmlReader to parse an XML fragment.

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

◆ XmlParserContext() [1/4]

System::Xml::XmlParserContext::XmlParserContext ( const SharedPtr< XmlNameTable > &  nt,
const SharedPtr< XmlNamespaceManager > &  nsMgr,
const String xmlLang,
System::Xml::XmlSpace  xmlSpace 
)

Initializes a new instance of the XmlParserContext class with the specified XmlNameTable, XmlNamespaceManager, xml:lang, and xml:space values.

Parameters
ntThe XmlNameTable to use to atomize strings. If this is nullptr, the name table used to construct the nsMgr is used instead. For more information about atomized strings, see XmlNameTable.
nsMgrThe XmlNamespaceManager to use for looking up namespace information, or nullptr.
xmlLangThe xml:lang scope.
xmlSpaceAn XmlSpace value indicating the xml:space scope.
Exceptions
XmlExceptionnt is not the same XmlNameTable used to construct nsMgr.

◆ XmlParserContext() [2/4]

System::Xml::XmlParserContext::XmlParserContext ( const SharedPtr< XmlNameTable > &  nt,
const SharedPtr< XmlNamespaceManager > &  nsMgr,
const String xmlLang,
System::Xml::XmlSpace  xmlSpace,
const SharedPtr< System::Text::Encoding > &  enc 
)

Initializes a new instance of the XmlParserContext class with the specified XmlNameTable, XmlNamespaceManager, xml:lang, xml:space, and encoding.

Parameters
ntThe XmlNameTable to use to atomize strings. If this is nullptr, the name table used to construct the nsMgr is used instead. For more information on atomized strings, see XmlNameTable.
nsMgrThe XmlNamespaceManager to use for looking up namespace information, or nullptr.
xmlLangThe xml:lang scope.
xmlSpaceAn XmlSpace value indicating the xml:space scope.
encAn Encoding object indicating the encoding setting.
Exceptions
XmlExceptionnt is not the same XmlNameTable used to construct nsMgr.

◆ XmlParserContext() [3/4]

System::Xml::XmlParserContext::XmlParserContext ( const SharedPtr< XmlNameTable > &  nt,
const SharedPtr< XmlNamespaceManager > &  nsMgr,
const String docTypeName,
const String pubId,
const String sysId,
const String internalSubset,
const String baseURI,
const String xmlLang,
System::Xml::XmlSpace  xmlSpace 
)

Initializes a new instance of the XmlParserContext class with the specified XmlNameTable, XmlNamespaceManager, base URI, xml:lang, xml:space, and document type values.

Parameters
ntThe XmlNameTable to use to atomize strings. If this is nullptr, the name table used to construct the nsMgr is used instead. For more information about atomized strings, see XmlNameTable.
nsMgrThe XmlNamespaceManager to use for looking up namespace information, or nullptr.
docTypeNameThe name of the document type declaration.
pubIdThe public identifier.
sysIdThe system identifier.
internalSubsetThe internal DTD subset. The DTD subset is used for entity resolution, not for document validation.
baseURIThe base URI for the XML fragment (the location from which the fragment was loaded).
xmlLangThe xml:lang scope.
xmlSpaceAn XmlSpace value indicating the xml:space scope.
Exceptions
XmlExceptionnt is not the same XmlNameTable used to construct nsMgr.

◆ XmlParserContext() [4/4]

System::Xml::XmlParserContext::XmlParserContext ( const SharedPtr< XmlNameTable > &  nt,
const SharedPtr< XmlNamespaceManager > &  nsMgr,
const String docTypeName,
const String pubId,
const String sysId,
const String internalSubset,
const String baseURI,
const String xmlLang,
System::Xml::XmlSpace  xmlSpace,
const SharedPtr< System::Text::Encoding > &  enc 
)

Initializes a new instance of the XmlParserContext class with the specified XmlNameTable, XmlNamespaceManager, base URI, xml:lang, xml:space, encoding, and document type values.

Parameters
ntThe XmlNameTable to use to atomize strings. If this is nullptr, the name table used to construct the nsMgr is used instead. For more information about atomized strings, see XmlNameTable.
nsMgrThe XmlNamespaceManager to use for looking up namespace information, or nullptr.
docTypeNameThe name of the document type declaration.
pubIdThe public identifier.
sysIdThe system identifier.
internalSubsetThe internal DTD subset. The DTD is used for entity resolution, not for document validation.
baseURIThe base URI for the XML fragment (the location from which the fragment was loaded).
xmlLangThe xml:lang scope.
xmlSpaceAn XmlSpace value indicating the xml:space scope.
encAn Encoding object indicating the encoding setting.
Exceptions
XmlExceptionnt is not the same XmlNameTable used to construct nsMgr.

Member Function Documentation

◆ get_BaseURI()

String System::Xml::XmlParserContext::get_BaseURI ( )

Returns the base URI.

Returns
The base URI to use to resolve the DTD file.

◆ get_DocTypeName()

String System::Xml::XmlParserContext::get_DocTypeName ( )

Returns the name of the document type declaration.

Returns
The name of the document type declaration.

◆ get_Encoding()

SharedPtr<System::Text::Encoding> System::Xml::XmlParserContext::get_Encoding ( )

Returns the encoding type.

Returns
An Encoding object indicating the encoding type.

◆ get_InternalSubset()

String System::Xml::XmlParserContext::get_InternalSubset ( )

Returns the internal DTD subset.

Returns
The internal DTD subset. For example, this method returns everything between the square brackets <!DOCTYPE doc [...]>.

◆ get_NamespaceManager()

SharedPtr<XmlNamespaceManager> System::Xml::XmlParserContext::get_NamespaceManager ( )

Returns the XmlNamespaceManager.

Returns
The XmlNamespaceManager.

◆ get_NameTable()

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

Returns the XmlNameTable used to atomize strings. For more information on atomized strings, see XmlNameTable.

Returns
The XmlNameTable.

◆ get_PublicId()

String System::Xml::XmlParserContext::get_PublicId ( )

Returns the public identifier.

Returns
The public identifier.

◆ get_SystemId()

String System::Xml::XmlParserContext::get_SystemId ( )

Returns the system identifier.

Returns
The system identifier.

◆ get_XmlLang()

String System::Xml::XmlParserContext::get_XmlLang ( )

Returns the current xml:lang scope.

Returns
The current xml:lang scope. If there is no xml:lang in scope, String::Empty is returned.

◆ get_XmlSpace()

System::Xml::XmlSpace System::Xml::XmlParserContext::get_XmlSpace ( )

Returns the current xml:space scope.

Returns
An XmlSpace value indicating the xml:space scope.

◆ set_BaseURI()

void System::Xml::XmlParserContext::set_BaseURI ( const String value)

Sets the base URI.

Parameters
valueThe value to set.

◆ set_DocTypeName()

void System::Xml::XmlParserContext::set_DocTypeName ( const String value)

Sets the name of the document type declaration.

Parameters
valueThe value to set.

◆ set_Encoding()

void System::Xml::XmlParserContext::set_Encoding ( const SharedPtr< System::Text::Encoding > &  value)

Sets the encoding type.

Parameters
valueThe value to set.

◆ set_InternalSubset()

void System::Xml::XmlParserContext::set_InternalSubset ( const String value)

Sets the internal DTD subset.

Parameters
valueThe value to set.

◆ set_NamespaceManager()

void System::Xml::XmlParserContext::set_NamespaceManager ( const SharedPtr< XmlNamespaceManager > &  value)

Sets the XmlNamespaceManager.

Parameters
valueThe value to set.

◆ set_NameTable()

void System::Xml::XmlParserContext::set_NameTable ( const SharedPtr< XmlNameTable > &  value)

Sets the XmlNameTable used to atomize strings. For more information on atomized strings, see XmlNameTable.

Parameters
valueThe value to set.

◆ set_PublicId()

void System::Xml::XmlParserContext::set_PublicId ( const String value)

Sets the public identifier.

Parameters
valueThe value to set.

◆ set_SystemId()

void System::Xml::XmlParserContext::set_SystemId ( const String value)

Sets the system identifier.

Parameters
valueThe value to set.

◆ set_XmlLang()

void System::Xml::XmlParserContext::set_XmlLang ( const String value)

Sets the current xml:lang scope.

Parameters
valueThe value to set.

◆ set_XmlSpace()

void System::Xml::XmlParserContext::set_XmlSpace ( System::Xml::XmlSpace  value)

Sets the current xml:space scope.

Parameters
valueThe value to set.