Asposecpplib

Performs serialization and deserialization of objects into and from XML documents. 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::Object.

Public Member Functions

virtual bool CanDeserialize (System::SharedPtr< XmlReader > xmlReader)
 Checks if specific reader is in deserializable state. More...
 
System::SharedPtr< ObjectDeserialize (System::SharedPtr< IO::Stream > stream)
 Deserializes XML document into object. More...
 
System::SharedPtr< ObjectDeserialize (System::SharedPtr< IO::TextReader > textReader)
 Deserializes XML document into object. More...
 
System::SharedPtr< ObjectDeserialize (System::SharedPtr< XmlReader > xmlReader)
 Deserializes XML document into object. More...
 
void Serialize (System::SharedPtr< IO::Stream > stream, System::SharedPtr< Object > o)
 Serializes document into XML. More...
 
void Serialize (System::SharedPtr< IO::TextWriter > textWriter, System::SharedPtr< Object > o)
 Serializes document into XML. More...
 
void Serialize (System::SharedPtr< XmlWriter > xmlWriter, System::SharedPtr< Object > o)
 Serializes document into XML. More...
 
void Serialize (System::SharedPtr< IO::Stream > stream, System::SharedPtr< Object > o, System::SharedPtr< XmlSerializerNamespaces > namespaces)
 Serializes document into XML. More...
 
void Serialize (System::SharedPtr< IO::TextWriter > textWriter, System::SharedPtr< Object > o, System::SharedPtr< XmlSerializerNamespaces > namespaces)
 Serializes document into XML. More...
 
void Serialize (System::SharedPtr< XmlWriter > xmlWriter, System::SharedPtr< Object > o, System::SharedPtr< XmlSerializerNamespaces > namespaces)
 Serializes document into XML. More...
 
System::SharedPtr< ObjectDeserialize (System::SharedPtr< XmlReader > xmlReader, String encodingStyle)
 Deserializes XML document into object. More...
 
void Serialize (System::SharedPtr< XmlWriter > xmlWriter, System::SharedPtr< Object > o, System::SharedPtr< XmlSerializerNamespaces > namespaces, String encodingStyle)
 Serializes document into XML. More...
 
void Serialize (System::SharedPtr< XmlWriter > xmlWriter, System::SharedPtr< Object > o, System::SharedPtr< XmlSerializerNamespaces > namespaces, String encodingStyle, String id)
 Serializes document into XML. 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...
 

Static Public Attributes

static const String WsdlNamespace
 WSDL namespace name. More...
 
static const String EncodingNamespace
 Encoding namespace name. More...
 
static const String WsdlTypesNamespace
 WSDL types namespace name. More...
 

Protected Member Functions

 XmlSerializer ()
 Constructor. More...
 
virtual System::SharedPtr< XmlSerializationReaderCreateReader ()
 Creates reader object. More...
 
virtual System::SharedPtr< XmlSerializationWriterCreateWriter ()
 Creates writer object. More...
 
virtual System::SharedPtr< ObjectDeserialize (System::SharedPtr< XmlSerializationReader > reader)
 Deeserializes document read from specific reader. More...
 
virtual void Serialize (System::SharedPtr< Object > o, System::SharedPtr< XmlSerializationWriter > writer)
 Serializes object. More...
 

Static Protected Member Functions

static System::SharedPtr< Text::Encodingget_DefaultEncoding ()
 Gets encoding used by default. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. 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 ()
 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

Performs serialization and deserialization of objects into and from XML documents. 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

◆ XmlSerializer()

System::Xml::Serialization::XmlSerializer::XmlSerializer ( )
protected

Constructor.

Member Function Documentation

◆ CanDeserialize()

virtual bool System::Xml::Serialization::XmlSerializer::CanDeserialize ( System::SharedPtr< XmlReader xmlReader)
virtual

Checks if specific reader is in deserializable state.

Parameters
xmlReaderReader to check.
Returns
true if xmlReader can be deserialized, false otherwise.

◆ CreateReader()

virtual System::SharedPtr<XmlSerializationReader> System::Xml::Serialization::XmlSerializer::CreateReader ( )
protectedvirtual

Creates reader object.

◆ CreateWriter()

virtual System::SharedPtr<XmlSerializationWriter> System::Xml::Serialization::XmlSerializer::CreateWriter ( )
protectedvirtual

Creates writer object.

◆ Deserialize() [1/5]

System::SharedPtr<Object> System::Xml::Serialization::XmlSerializer::Deserialize ( System::SharedPtr< IO::Stream stream)

Deserializes XML document into object.

Parameters
streamStream to read document from.
Returns
Object that was previously serialized into the document given.

◆ Deserialize() [2/5]

System::SharedPtr<Object> System::Xml::Serialization::XmlSerializer::Deserialize ( System::SharedPtr< IO::TextReader textReader)

Deserializes XML document into object.

Parameters
textReaderReader to read document from.
Returns
Object that was previously serialized into the document given.

◆ Deserialize() [3/5]

System::SharedPtr<Object> System::Xml::Serialization::XmlSerializer::Deserialize ( System::SharedPtr< XmlReader xmlReader)

Deserializes XML document into object.

Parameters
xmlReaderReader to read document from.
Returns
Object that was previously serialized into the document given.

◆ Deserialize() [4/5]

System::SharedPtr<Object> System::Xml::Serialization::XmlSerializer::Deserialize ( System::SharedPtr< XmlReader xmlReader,
String  encodingStyle 
)

Deserializes XML document into object.

Parameters
xmlReaderReader to read document from.
encodingStyleStyle used to serialize object.
Returns
Object that was previously serialized into the document given.

◆ Deserialize() [5/5]

virtual System::SharedPtr<Object> System::Xml::Serialization::XmlSerializer::Deserialize ( System::SharedPtr< XmlSerializationReader reader)
protectedvirtual

Deeserializes document read from specific reader.

◆ get_DefaultEncoding()

static System::SharedPtr<Text::Encoding> System::Xml::Serialization::XmlSerializer::get_DefaultEncoding ( )
staticprotected

Gets encoding used by default.

◆ Serialize() [1/9]

void System::Xml::Serialization::XmlSerializer::Serialize ( System::SharedPtr< IO::Stream stream,
System::SharedPtr< Object o 
)

Serializes document into XML.

Parameters
streamDestination stream.
oObject to serialize.

◆ Serialize() [2/9]

void System::Xml::Serialization::XmlSerializer::Serialize ( System::SharedPtr< IO::Stream stream,
System::SharedPtr< Object o,
System::SharedPtr< XmlSerializerNamespaces namespaces 
)

Serializes document into XML.

Parameters
streamDestination stream.
oObject to serialize.
namespacesNamespace storage.

◆ Serialize() [3/9]

void System::Xml::Serialization::XmlSerializer::Serialize ( System::SharedPtr< IO::TextWriter textWriter,
System::SharedPtr< Object o 
)

Serializes document into XML.

Parameters
textWriterDestination stream.
oObject to serialize.

◆ Serialize() [4/9]

void System::Xml::Serialization::XmlSerializer::Serialize ( System::SharedPtr< IO::TextWriter textWriter,
System::SharedPtr< Object o,
System::SharedPtr< XmlSerializerNamespaces namespaces 
)

Serializes document into XML.

Parameters
textWriterDestination stream.
oObject to serialize.
namespacesNamespace storage.

◆ Serialize() [5/9]

virtual void System::Xml::Serialization::XmlSerializer::Serialize ( System::SharedPtr< Object o,
System::SharedPtr< XmlSerializationWriter writer 
)
protectedvirtual

Serializes object.

◆ Serialize() [6/9]

void System::Xml::Serialization::XmlSerializer::Serialize ( System::SharedPtr< XmlWriter xmlWriter,
System::SharedPtr< Object o 
)

Serializes document into XML.

Parameters
xmlWriterDestination stream.
oObject to serialize.

◆ Serialize() [7/9]

void System::Xml::Serialization::XmlSerializer::Serialize ( System::SharedPtr< XmlWriter xmlWriter,
System::SharedPtr< Object o,
System::SharedPtr< XmlSerializerNamespaces namespaces 
)

Serializes document into XML.

Parameters
xmlWriterDestination stream.
oObject to serialize.
namespacesNamespace storage.

◆ Serialize() [8/9]

void System::Xml::Serialization::XmlSerializer::Serialize ( System::SharedPtr< XmlWriter xmlWriter,
System::SharedPtr< Object o,
System::SharedPtr< XmlSerializerNamespaces namespaces,
String  encodingStyle 
)

Serializes document into XML.

Parameters
xmlWriterDestination stream.
oObject to serialize.
namespacesNamespace storage.
encodingStyleStyle to use while serializing object.

◆ Serialize() [9/9]

void System::Xml::Serialization::XmlSerializer::Serialize ( System::SharedPtr< XmlWriter xmlWriter,
System::SharedPtr< Object o,
System::SharedPtr< XmlSerializerNamespaces namespaces,
String  encodingStyle,
String  id 
)

Serializes document into XML.

Parameters
xmlWriterDestination stream.
oObject to serialize.
namespacesNamespace storage.
encodingStyleStyle to use while serializing object.
idObject id to use while serializing it.

Member Data Documentation

◆ EncodingNamespace

const String System::Xml::Serialization::XmlSerializer::EncodingNamespace
static

Encoding namespace name.

◆ WsdlNamespace

const String System::Xml::Serialization::XmlSerializer::WsdlNamespace
static

WSDL namespace name.

◆ WsdlTypesNamespace

const String System::Xml::Serialization::XmlSerializer::WsdlTypesNamespace
static

WSDL types namespace name.