PostSerializer

Overview

Class for serializing/deserializing data of any type to a PostMessage format.

Any WriteXXXX method has simmetrical ReadXXXX method so You can easily write and read any objects. While using Write methods then class stores results of their work to the inner string storage. You can retrieve the string representation of this storage by reading the MessageText property.

To operate with custom types, TypeManager class is using.

This class is used by PostMessage to read/write data. In most cases there is no need to instantiate this class directly.

For internal use only.

Location


 

constructor  protected    (declared in Serializer)

Empty constructor.

 

constructor

 

PostSerializer()

 

Sub New()

constructor (PostMessage)

 

constructor(owner: PostMessage)

 

PostSerializer(PostMessage owner)

 

Sub New(owner As PostMessage)

Parameters:

  • owner:

BeginReadComplex  protected

 

method BeginReadComplex(name: String; type: Type; out value: ComplexType): Boolean

 

Boolean BeginReadComplex(String name, Type type, out ComplexType value)

 

Function BeginReadComplex(name As String, type As Type, <OutAttribute> ByRef value As ComplexType) As Boolean

Parameters:

  • name:
  • type:
  • value:

BeginReadObject  protected

Deserializes data of any object type.

 

method BeginReadObject(name: String; type: Type): Object

 

Object BeginReadObject(String name, Type type)

 

Function BeginReadObject(name As String, type As Type) As Object

Parameters:

  • name: Name of the object to read
  • type: Type of the object to read

BeginWriteComplex  protected

 

method BeginWriteComplex(name: String; value: ComplexType): Boolean

 

Boolean BeginWriteComplex(String name, ComplexType value)

 

Function BeginWriteComplex(name As String, value As ComplexType) As Boolean

Parameters:

  • name:
  • value:

BeginWriteObject  protected

 

method BeginWriteObject(name: String; value: Object)

 

void BeginWriteObject(String name, Object value)

 

Sub BeginWriteObject(name As String, value As Object)

Parameters:

  • name:
  • value:

Clear

 

method Clear

 

void Clear()

 

Sub Clear()

CodeFirstTypeConverters    (declared in Serializer)

 

class property CodeFirstTypeConverters: Dictionary<Type, CodeFirstTypeConverterRegistration> read;

 

class Dictionary<Type, CodeFirstTypeConverterRegistration> CodeFirstTypeConverters { get; }

 

Shared ReadOnly Property CodeFirstTypeConverters() As Dictionary<Type, CodeFirstTypeConverterRegistration>

CreateComplexTypeInstance  protected    (declared in Serializer)

 

method CreateComplexTypeInstance(className: String): ComplexType

 

ComplexType CreateComplexTypeInstance(String className)

 

Function CreateComplexTypeInstance(className As String) As ComplexType

Parameters:

  • className:

EndReadComplex  protected

 

method EndReadComplex

 

void EndReadComplex()

 

Sub EndReadComplex()

EndReadObject  protected

Deserializes data of any object type.

 

method EndReadObject

 

void EndReadObject()

 

Sub EndReadObject()

EndWriteComplex  protected

 

method EndWriteComplex(value: ComplexType)

 

void EndWriteComplex(ComplexType value)

 

Sub EndWriteComplex(value As ComplexType)

Parameters:

  • value:

EndWriteObject  protected

 

method EndWriteObject

 

void EndWriteObject()

 

Sub EndWriteObject()

getValue

 

method getValue(key: String): String

 

String getValue(String key)

 

Function getValue(key As String) As String

Parameters:

  • key:

MessageText

Text representation of inner storage of string values.

 

property MessageText: String read;

 

String MessageText { get; }

 

ReadOnly Property MessageText() As String

Read    (declared in Serializer)

The general method for reading that calls specific ReadXXX method dependently on the type of an object to read.

 

method Read(name: String; type: Type; format: StreamingFormat): Object

 

Object Read(String name, Type type, StreamingFormat format)

 

Function Read(name As String, type As Type, format As StreamingFormat) As Object

Parameters:

  • name:
  • type:
  • format:

ReadAnsiString

 

method ReadAnsiString(name: String): String

 

String ReadAnsiString(String name)

 

Function ReadAnsiString(name As String) As String

Parameters:

  • name:

ReadArray

 

method ReadArray(name: String; type: Type; format: StreamingFormat): Array

 

Array ReadArray(String name, Type type, StreamingFormat format)

 

Function ReadArray(name As String, type As Type, format As StreamingFormat) As Array

Parameters:

  • name:
  • type:
  • format:

ReadBinary

 

method ReadBinary(name: String): Binary

 

Binary ReadBinary(String name)

 

Function ReadBinary(name As String) As Binary

Parameters:

  • name:

ReadBoolean

 

method ReadBoolean(name: String): Boolean

 

Boolean ReadBoolean(String name)

 

Function ReadBoolean(name As String) As Boolean

Parameters:

  • name:

ReadComplex    (declared in Serializer)

 

method ReadComplex(name: String; type: Type): ComplexType

 

ComplexType ReadComplex(String name, Type type)

 

Function ReadComplex(name As String, type As Type) As ComplexType

Parameters:

  • name:
  • type:

ReadCurrency

 

method ReadCurrency(name: String): Decimal

 

Decimal ReadCurrency(String name)

 

Function ReadCurrency(name As String) As Decimal

Parameters:

  • name:

ReadCustomEnum

 

method ReadCustomEnum(name: String): ICustomEnum

 

ICustomEnum ReadCustomEnum(String name)

 

Function ReadCustomEnum(name As String) As ICustomEnum

Parameters:

  • name:

ReadDateTime

 

method ReadDateTime(name: String): DateTime

 

DateTime ReadDateTime(String name)

 

Function ReadDateTime(name As String) As DateTime

Parameters:

  • name:

ReadDecimal

 

method ReadDecimal(name: String): Decimal

 

Decimal ReadDecimal(String name)

 

Function ReadDecimal(name As String) As Decimal

Parameters:

  • name:

ReadDouble

 

method ReadDouble(name: String): Double

 

Double ReadDouble(String name)

 

Function ReadDouble(name As String) As Double

Parameters:

  • name:

ReadEnum

 

method ReadEnum(name: String; type: Type): Enum

 

Enum ReadEnum(String name, Type type)

 

Function ReadEnum(name As String, type As Type) As Enum

Parameters:

  • name:
  • type:

ReadException    (declared in Serializer)

 

method ReadException(type: Type; message: String; isFromServer: Boolean): Exception

 

Exception ReadException(Type type, String message, Boolean isFromServer)

 

Function ReadException(type As Type, message As String, isFromServer As Boolean) As Exception

Parameters:

  • type:
  • message:
  • isFromServer:

ReadFromStream

 

method ReadFromStream(stream: Stream)

 

void ReadFromStream(Stream stream)

 

Sub ReadFromStream(stream As Stream)

Parameters:

  • stream:

ReadGenericArray

 

method ReadGenericArray(name: String; type: Type; format: StreamingFormat): IList

 

IList ReadGenericArray(String name, Type type, StreamingFormat format)

 

Function ReadGenericArray(name As String, type As Type, format As StreamingFormat) As IList

Parameters:

  • name:
  • type:
  • format:

ReadGuid

 

method ReadGuid(name: String): Guid

 

Guid ReadGuid(String name)

 

Function ReadGuid(name As String) As Guid

Parameters:

  • name:

ReadInt32

Reads Int32 value.

 

method ReadInt32(name: String): Int32

 

Int32 ReadInt32(String name)

 

Function ReadInt32(name As String) As Int32

Parameters:

  • name:

ReadInt64

Reads Int64 value.

 

method ReadInt64(name: String): Int64

 

Int64 ReadInt64(String name)

 

Function ReadInt64(name As String) As Int64

Parameters:

  • name:

ReadItem

 

method ReadItem(name: String): String

 

String ReadItem(String name)

 

Function ReadItem(name As String) As String

Parameters:

  • name:

ReadNullableBoolean

 

method ReadNullableBoolean(name: String): nullable Boolean

 

Boolean? ReadNullableBoolean(String name)

 

Function ReadNullableBoolean(name As String) As Boolean?

Parameters:

  • name:

ReadNullableCurrency

 

method ReadNullableCurrency(name: String): nullable Decimal

 

Decimal? ReadNullableCurrency(String name)

 

Function ReadNullableCurrency(name As String) As Decimal?

Parameters:

  • name:

ReadNullableDateTime

 

method ReadNullableDateTime(name: String): nullable DateTime

 

DateTime? ReadNullableDateTime(String name)

 

Function ReadNullableDateTime(name As String) As DateTime?

Parameters:

  • name:

ReadNullableDecimal

 

method ReadNullableDecimal(name: String): nullable Decimal

 

Decimal? ReadNullableDecimal(String name)

 

Function ReadNullableDecimal(name As String) As Decimal?

Parameters:

  • name:

ReadNullableDouble

 

method ReadNullableDouble(name: String): nullable Double

 

Double? ReadNullableDouble(String name)

 

Function ReadNullableDouble(name As String) As Double?

Parameters:

  • name:

ReadNullableEnum

 

method ReadNullableEnum(name: String; type: Type): nullable Enum

 

Enum? ReadNullableEnum(String name, Type type)

 

Function ReadNullableEnum(name As String, type As Type) As Enum?

Parameters:

  • name:
  • type:

ReadNullableGuid

 

method ReadNullableGuid(name: String): nullable Guid

 

Guid? ReadNullableGuid(String name)

 

Function ReadNullableGuid(name As String) As Guid?

Parameters:

  • name:

ReadNullableInt32

 

method ReadNullableInt32(name: String): nullable Int32

 

Int32? ReadNullableInt32(String name)

 

Function ReadNullableInt32(name As String) As Int32?

Parameters:

  • name:

ReadNullableInt64

 

method ReadNullableInt64(name: String): nullable Int64

 

Int64? ReadNullableInt64(String name)

 

Function ReadNullableInt64(name As String) As Int64?

Parameters:

  • name:

ReadObject    (declared in Serializer)

Deserializes data of any object type.

 

method ReadObject(name: String; type: Type): Object

 

Object ReadObject(String name, Type type)

 

Function ReadObject(name As String, type As Type) As Object

Parameters:

  • name: Name of the object to read
  • type: Type of the object to read

ReadObjectData    (declared in Serializer)

 

method ReadObjectData(value: Object)

 

void ReadObjectData(Object value)

 

Sub ReadObjectData(value As Object)

Parameters:

  • value:

ReadUtf8String

 

method ReadUtf8String(name: String): String

 

String ReadUtf8String(String name)

 

Function ReadUtf8String(name As String) As String

Parameters:

  • name:

ReadVariant

 

method ReadVariant(name: String): Object

 

Object ReadVariant(String name)

 

Function ReadVariant(name As String) As Object

Parameters:

  • name:

ReadWideString

 

method ReadWideString(name: String): String

 

String ReadWideString(String name)

 

Function ReadWideString(name As String) As String

Parameters:

  • name:

ReadXml

 

method ReadXml(name: String): XmlNode

 

XmlNode ReadXml(String name)

 

Function ReadXml(name As String) As XmlNode

Parameters:

  • name:

RecordStrictOrder    (declared in Serializer)

Order of complex types fields in which they will be serialized/deserialized. If set to true the order or fields remains the same as in native type. If false, fields will be ordered alphabetically. FALSE by default.

 

property RecordStrictOrder: Boolean read;

 

Boolean RecordStrictOrder { get; }

 

ReadOnly Property RecordStrictOrder() As Boolean

TypeFactory    (declared in Serializer)

When doing custom reading/writing of values, the type factory can be used to provide custom serializable types.

 

property TypeFactory: ITypeFactory read write;

 

ITypeFactory TypeFactory { get; set; }

 

Property TypeFactory() As ITypeFactory

Write (String, Object, StreamingFormat)    (declared in Serializer)

 

method Write(name: String; value: Object; format: StreamingFormat)

 

void Write(String name, Object value, StreamingFormat format)

 

Sub Write(name As String, value As Object, format As StreamingFormat)

Parameters:

  • name:
  • value:
  • format:

Write (String, Object, Type, StreamingFormat)    (declared in Serializer)

The general method for writing that calls specific WriteXXX method dependently on the type of an object to write.

 

method Write(name: String; value: Object; type: Type; format: StreamingFormat)

 

void Write(String name, Object value, Type type, StreamingFormat format)

 

Sub Write(name As String, value As Object, type As Type, format As StreamingFormat)

Parameters:

  • name:
  • value:
  • type:
  • format:

WriteAnsiString

 

method WriteAnsiString(name: String; value: String)

 

void WriteAnsiString(String name, String value)

 

Sub WriteAnsiString(name As String, value As String)

Parameters:

  • name:
  • value:

WriteArray

 

method WriteArray(name: String; value: Array; format: StreamingFormat)

 

void WriteArray(String name, Array value, StreamingFormat format)

 

Sub WriteArray(name As String, value As Array, format As StreamingFormat)

Parameters:

  • name:
  • value:
  • format:

WriteBinary

 

method WriteBinary(name: String; value: Stream)

 

void WriteBinary(String name, Stream value)

 

Sub WriteBinary(name As String, value As Stream)

Parameters:

  • name:
  • value:

WriteBoolean

 

method WriteBoolean(name: String; value: Boolean)

 

void WriteBoolean(String name, Boolean value)

 

Sub WriteBoolean(name As String, value As Boolean)

Parameters:

  • name:
  • value:

WriteComplex    (declared in Serializer)

 

method WriteComplex(name: String; value: ComplexType)

 

void WriteComplex(String name, ComplexType value)

 

Sub WriteComplex(name As String, value As ComplexType)

Parameters:

  • name:
  • value:

WriteCurrency

 

method WriteCurrency(name: String; value: Decimal)

 

void WriteCurrency(String name, Decimal value)

 

Sub WriteCurrency(name As String, value As Decimal)

Parameters:

  • name:
  • value:

WriteCustomEnum

 

method WriteCustomEnum(name: String; value: ICustomEnum)

 

void WriteCustomEnum(String name, ICustomEnum value)

 

Sub WriteCustomEnum(name As String, value As ICustomEnum)

Parameters:

  • name:
  • value:

WriteDateTime

 

method WriteDateTime(name: String; value: DateTime)

 

void WriteDateTime(String name, DateTime value)

 

Sub WriteDateTime(name As String, value As DateTime)

Parameters:

  • name:
  • value:

WriteDecimal

 

method WriteDecimal(name: String; value: Decimal)

 

void WriteDecimal(String name, Decimal value)

 

Sub WriteDecimal(name As String, value As Decimal)

Parameters:

  • name:
  • value:

WriteDouble

 

method WriteDouble(name: String; value: Double)

 

void WriteDouble(String name, Double value)

 

Sub WriteDouble(name As String, value As Double)

Parameters:

  • name:
  • value:

WriteEnum

 

method WriteEnum(name: String; value: Enum)

 

void WriteEnum(String name, Enum value)

 

Sub WriteEnum(name As String, value As Enum)

Parameters:

  • name:
  • value:

WriteGenericArray

 

method WriteGenericArray(name: String; value: IList; format: StreamingFormat)

 

void WriteGenericArray(String name, IList value, StreamingFormat format)

 

Sub WriteGenericArray(name As String, value As IList, format As StreamingFormat)

Parameters:

  • name:
  • value:
  • format:

WriteGuid

 

method WriteGuid(name: String; value: Guid)

 

void WriteGuid(String name, Guid value)

 

Sub WriteGuid(name As String, value As Guid)

Parameters:

  • name:
  • value:

WriteInt32

 

method WriteInt32(name: String; value: Int32)

 

void WriteInt32(String name, Int32 value)

 

Sub WriteInt32(name As String, value As Int32)

Parameters:

  • name:
  • value:

WriteInt64

 

method WriteInt64(name: String; value: Int64)

 

void WriteInt64(String name, Int64 value)

 

Sub WriteInt64(name As String, value As Int64)

Parameters:

  • name:
  • value:

WriteItem

Method is used in almost all WriteXXX methods of the class. It adds its input parameters as "key=value" to the inner string storage.

 

method WriteItem(name: String; value: String)

 

void WriteItem(String name, String value)

 

Sub WriteItem(name As String, value As String)

Parameters:

  • name:
  • value:

WriteNullableBoolean

 

method WriteNullableBoolean(name: String; value: Nullable<Boolean>)

 

void WriteNullableBoolean(String name, Nullable<Boolean> value)

 

Sub WriteNullableBoolean(name As String, value As Nullable<Boolean>)

Parameters:

  • name:
  • value:

WriteNullableCurrency

 

method WriteNullableCurrency(name: String; value: Nullable<Decimal>)

 

void WriteNullableCurrency(String name, Nullable<Decimal> value)

 

Sub WriteNullableCurrency(name As String, value As Nullable<Decimal>)

Parameters:

  • name:
  • value:

WriteNullableDateTime

 

method WriteNullableDateTime(name: String; value: Nullable<DateTime>)

 

void WriteNullableDateTime(String name, Nullable<DateTime> value)

 

Sub WriteNullableDateTime(name As String, value As Nullable<DateTime>)

Parameters:

  • name:
  • value:

WriteNullableDecimal

 

method WriteNullableDecimal(name: String; value: Nullable<Decimal>)

 

void WriteNullableDecimal(String name, Nullable<Decimal> value)

 

Sub WriteNullableDecimal(name As String, value As Nullable<Decimal>)

Parameters:

  • name:
  • value:

WriteNullableDouble

 

method WriteNullableDouble(name: String; value: Nullable<Double>)

 

void WriteNullableDouble(String name, Nullable<Double> value)

 

Sub WriteNullableDouble(name As String, value As Nullable<Double>)

Parameters:

  • name:
  • value:

WriteNullableEnum

 

method WriteNullableEnum(name: String; value: nullable Enum)

 

void WriteNullableEnum(String name, Enum? value)

 

Sub WriteNullableEnum(name As String, value As Enum?)

Parameters:

  • name:
  • value:

WriteNullableGuid

 

method WriteNullableGuid(name: String; value: Nullable<Guid>)

 

void WriteNullableGuid(String name, Nullable<Guid> value)

 

Sub WriteNullableGuid(name As String, value As Nullable<Guid>)

Parameters:

  • name:
  • value:

WriteNullableInt32

 

method WriteNullableInt32(name: String; value: Nullable<Int32>)

 

void WriteNullableInt32(String name, Nullable<Int32> value)

 

Sub WriteNullableInt32(name As String, value As Nullable<Int32>)

Parameters:

  • name:
  • value:

WriteNullableInt64

 

method WriteNullableInt64(name: String; value: Nullable<Int64>)

 

void WriteNullableInt64(String name, Nullable<Int64> value)

 

Sub WriteNullableInt64(name As String, value As Nullable<Int64>)

Parameters:

  • name:
  • value:

WriteObject    (declared in Serializer)

This method is a wrapper for Write method. It defines a type and streaming format of passed object.

 

method WriteObject(name: String; value: Object)

 

void WriteObject(String name, Object value)

 

Sub WriteObject(name As String, value As Object)

Parameters:

  • name:
  • value:

WriteObjectData    (declared in Serializer)

 

method WriteObjectData(value: Object)

 

void WriteObjectData(Object value)

 

Sub WriteObjectData(value As Object)

Parameters:

  • value:

WriteToStream

 

method WriteToStream(stream: Stream)

 

void WriteToStream(Stream stream)

 

Sub WriteToStream(stream As Stream)

Parameters:

  • stream:

WriteUtf8String

 

method WriteUtf8String(name: String; value: String)

 

void WriteUtf8String(String name, String value)

 

Sub WriteUtf8String(name As String, value As String)

Parameters:

  • name:
  • value:

WriteVariant

 

method WriteVariant(name: String; value: Object)

 

void WriteVariant(String name, Object value)

 

Sub WriteVariant(name As String, value As Object)

Parameters:

  • name:
  • value:

WriteWideString

 

method WriteWideString(name: String; value: String)

 

void WriteWideString(String name, String value)

 

Sub WriteWideString(name As String, value As String)

Parameters:

  • name:
  • value:

WriteXml

 

method WriteXml(name: String; value: XmlNode)

 

void WriteXml(String name, XmlNode value)

 

Sub WriteXml(name As String, value As XmlNode)

Parameters:

  • name:
  • value:

 

MessageText

Text representation of inner storage of string values.

 

property MessageText: String read;

 

String MessageText { get; }

 

ReadOnly Property MessageText() As String

RecordStrictOrder    (declared in Serializer)

Order of complex types fields in which they will be serialized/deserialized. If set to true the order or fields remains the same as in native type. If false, fields will be ordered alphabetically. FALSE by default.

 

property RecordStrictOrder: Boolean read;

 

Boolean RecordStrictOrder { get; }

 

ReadOnly Property RecordStrictOrder() As Boolean

TypeFactory    (declared in Serializer)

When doing custom reading/writing of values, the type factory can be used to provide custom serializable types.

 

property TypeFactory: ITypeFactory read write;

 

ITypeFactory TypeFactory { get; set; }

 

Property TypeFactory() As ITypeFactory

CodeFirstTypeConverters    (declared in Serializer)

 

class property CodeFirstTypeConverters: Dictionary<Type, CodeFirstTypeConverterRegistration> read;

 

class Dictionary<Type, CodeFirstTypeConverterRegistration> CodeFirstTypeConverters { get; }

 

Shared ReadOnly Property CodeFirstTypeConverters() As Dictionary<Type, CodeFirstTypeConverterRegistration>

 

constructor  protected    (declared in Serializer)

Empty constructor.

 

constructor

 

PostSerializer()

 

Sub New()

constructor (PostMessage)

 

constructor(owner: PostMessage)

 

PostSerializer(PostMessage owner)

 

Sub New(owner As PostMessage)

Parameters:

  • owner:

BeginReadComplex  protected

 

method BeginReadComplex(name: String; type: Type; out value: ComplexType): Boolean

 

Boolean BeginReadComplex(String name, Type type, out ComplexType value)

 

Function BeginReadComplex(name As String, type As Type, <OutAttribute> ByRef value As ComplexType) As Boolean

Parameters:

  • name:
  • type:
  • value:

BeginReadObject  protected

Deserializes data of any object type.

 

method BeginReadObject(name: String; type: Type): Object

 

Object BeginReadObject(String name, Type type)

 

Function BeginReadObject(name As String, type As Type) As Object

Parameters:

  • name: Name of the object to read
  • type: Type of the object to read

BeginWriteComplex  protected

 

method BeginWriteComplex(name: String; value: ComplexType): Boolean

 

Boolean BeginWriteComplex(String name, ComplexType value)

 

Function BeginWriteComplex(name As String, value As ComplexType) As Boolean

Parameters:

  • name:
  • value:

BeginWriteObject  protected

 

method BeginWriteObject(name: String; value: Object)

 

void BeginWriteObject(String name, Object value)

 

Sub BeginWriteObject(name As String, value As Object)

Parameters:

  • name:
  • value:

Clear

 

method Clear

 

void Clear()

 

Sub Clear()

CreateComplexTypeInstance  protected    (declared in Serializer)

 

method CreateComplexTypeInstance(className: String): ComplexType

 

ComplexType CreateComplexTypeInstance(String className)

 

Function CreateComplexTypeInstance(className As String) As ComplexType

Parameters:

  • className:

EndReadComplex  protected

 

method EndReadComplex

 

void EndReadComplex()

 

Sub EndReadComplex()

EndReadObject  protected

Deserializes data of any object type.

 

method EndReadObject

 

void EndReadObject()

 

Sub EndReadObject()

EndWriteComplex  protected

 

method EndWriteComplex(value: ComplexType)

 

void EndWriteComplex(ComplexType value)

 

Sub EndWriteComplex(value As ComplexType)

Parameters:

  • value:

EndWriteObject  protected

 

method EndWriteObject

 

void EndWriteObject()

 

Sub EndWriteObject()

getValue

 

method getValue(key: String): String

 

String getValue(String key)

 

Function getValue(key As String) As String

Parameters:

  • key:

Read    (declared in Serializer)

The general method for reading that calls specific ReadXXX method dependently on the type of an object to read.

 

method Read(name: String; type: Type; format: StreamingFormat): Object

 

Object Read(String name, Type type, StreamingFormat format)

 

Function Read(name As String, type As Type, format As StreamingFormat) As Object

Parameters:

  • name:
  • type:
  • format:

ReadAnsiString

 

method ReadAnsiString(name: String): String

 

String ReadAnsiString(String name)

 

Function ReadAnsiString(name As String) As String

Parameters:

  • name:

ReadArray

 

method ReadArray(name: String; type: Type; format: StreamingFormat): Array

 

Array ReadArray(String name, Type type, StreamingFormat format)

 

Function ReadArray(name As String, type As Type, format As StreamingFormat) As Array

Parameters:

  • name:
  • type:
  • format:

ReadBinary

 

method ReadBinary(name: String): Binary

 

Binary ReadBinary(String name)

 

Function ReadBinary(name As String) As Binary

Parameters:

  • name:

ReadBoolean

 

method ReadBoolean(name: String): Boolean

 

Boolean ReadBoolean(String name)

 

Function ReadBoolean(name As String) As Boolean

Parameters:

  • name:

ReadComplex    (declared in Serializer)

 

method ReadComplex(name: String; type: Type): ComplexType

 

ComplexType ReadComplex(String name, Type type)

 

Function ReadComplex(name As String, type As Type) As ComplexType

Parameters:

  • name:
  • type:

ReadCurrency

 

method ReadCurrency(name: String): Decimal

 

Decimal ReadCurrency(String name)

 

Function ReadCurrency(name As String) As Decimal

Parameters:

  • name:

ReadCustomEnum

 

method ReadCustomEnum(name: String): ICustomEnum

 

ICustomEnum ReadCustomEnum(String name)

 

Function ReadCustomEnum(name As String) As ICustomEnum

Parameters:

  • name:

ReadDateTime

 

method ReadDateTime(name: String): DateTime

 

DateTime ReadDateTime(String name)

 

Function ReadDateTime(name As String) As DateTime

Parameters:

  • name:

ReadDecimal

 

method ReadDecimal(name: String): Decimal

 

Decimal ReadDecimal(String name)

 

Function ReadDecimal(name As String) As Decimal

Parameters:

  • name:

ReadDouble

 

method ReadDouble(name: String): Double

 

Double ReadDouble(String name)

 

Function ReadDouble(name As String) As Double

Parameters:

  • name:

ReadEnum

 

method ReadEnum(name: String; type: Type): Enum

 

Enum ReadEnum(String name, Type type)

 

Function ReadEnum(name As String, type As Type) As Enum

Parameters:

  • name:
  • type:

ReadException    (declared in Serializer)

 

method ReadException(type: Type; message: String; isFromServer: Boolean): Exception

 

Exception ReadException(Type type, String message, Boolean isFromServer)

 

Function ReadException(type As Type, message As String, isFromServer As Boolean) As Exception

Parameters:

  • type:
  • message:
  • isFromServer:

ReadFromStream

 

method ReadFromStream(stream: Stream)

 

void ReadFromStream(Stream stream)

 

Sub ReadFromStream(stream As Stream)

Parameters:

  • stream:

ReadGenericArray

 

method ReadGenericArray(name: String; type: Type; format: StreamingFormat): IList

 

IList ReadGenericArray(String name, Type type, StreamingFormat format)

 

Function ReadGenericArray(name As String, type As Type, format As StreamingFormat) As IList

Parameters:

  • name:
  • type:
  • format:

ReadGuid

 

method ReadGuid(name: String): Guid

 

Guid ReadGuid(String name)

 

Function ReadGuid(name As String) As Guid

Parameters:

  • name:

ReadInt32

Reads Int32 value.

 

method ReadInt32(name: String): Int32

 

Int32 ReadInt32(String name)

 

Function ReadInt32(name As String) As Int32

Parameters:

  • name:

ReadInt64

Reads Int64 value.

 

method ReadInt64(name: String): Int64

 

Int64 ReadInt64(String name)

 

Function ReadInt64(name As String) As Int64

Parameters:

  • name:

ReadItem

 

method ReadItem(name: String): String

 

String ReadItem(String name)

 

Function ReadItem(name As String) As String

Parameters:

  • name:

ReadNullableBoolean

 

method ReadNullableBoolean(name: String): nullable Boolean

 

Boolean? ReadNullableBoolean(String name)

 

Function ReadNullableBoolean(name As String) As Boolean?

Parameters:

  • name:

ReadNullableCurrency

 

method ReadNullableCurrency(name: String): nullable Decimal

 

Decimal? ReadNullableCurrency(String name)

 

Function ReadNullableCurrency(name As String) As Decimal?

Parameters:

  • name:

ReadNullableDateTime

 

method ReadNullableDateTime(name: String): nullable DateTime

 

DateTime? ReadNullableDateTime(String name)

 

Function ReadNullableDateTime(name As String) As DateTime?

Parameters:

  • name:

ReadNullableDecimal

 

method ReadNullableDecimal(name: String): nullable Decimal

 

Decimal? ReadNullableDecimal(String name)

 

Function ReadNullableDecimal(name As String) As Decimal?

Parameters:

  • name:

ReadNullableDouble

 

method ReadNullableDouble(name: String): nullable Double

 

Double? ReadNullableDouble(String name)

 

Function ReadNullableDouble(name As String) As Double?

Parameters:

  • name:

ReadNullableEnum

 

method ReadNullableEnum(name: String; type: Type): nullable Enum

 

Enum? ReadNullableEnum(String name, Type type)

 

Function ReadNullableEnum(name As String, type As Type) As Enum?

Parameters:

  • name:
  • type:

ReadNullableGuid

 

method ReadNullableGuid(name: String): nullable Guid

 

Guid? ReadNullableGuid(String name)

 

Function ReadNullableGuid(name As String) As Guid?

Parameters:

  • name:

ReadNullableInt32

 

method ReadNullableInt32(name: String): nullable Int32

 

Int32? ReadNullableInt32(String name)

 

Function ReadNullableInt32(name As String) As Int32?

Parameters:

  • name:

ReadNullableInt64

 

method ReadNullableInt64(name: String): nullable Int64

 

Int64? ReadNullableInt64(String name)

 

Function ReadNullableInt64(name As String) As Int64?

Parameters:

  • name:

ReadObject    (declared in Serializer)

Deserializes data of any object type.

 

method ReadObject(name: String; type: Type): Object

 

Object ReadObject(String name, Type type)

 

Function ReadObject(name As String, type As Type) As Object

Parameters:

  • name: Name of the object to read
  • type: Type of the object to read

ReadObjectData    (declared in Serializer)

 

method ReadObjectData(value: Object)

 

void ReadObjectData(Object value)

 

Sub ReadObjectData(value As Object)

Parameters:

  • value:

ReadUtf8String

 

method ReadUtf8String(name: String): String

 

String ReadUtf8String(String name)

 

Function ReadUtf8String(name As String) As String

Parameters:

  • name:

ReadVariant

 

method ReadVariant(name: String): Object

 

Object ReadVariant(String name)

 

Function ReadVariant(name As String) As Object

Parameters:

  • name:

ReadWideString

 

method ReadWideString(name: String): String

 

String ReadWideString(String name)

 

Function ReadWideString(name As String) As String

Parameters:

  • name:

ReadXml

 

method ReadXml(name: String): XmlNode

 

XmlNode ReadXml(String name)

 

Function ReadXml(name As String) As XmlNode

Parameters:

  • name:

Write (String, Object, StreamingFormat)    (declared in Serializer)

 

method Write(name: String; value: Object; format: StreamingFormat)

 

void Write(String name, Object value, StreamingFormat format)

 

Sub Write(name As String, value As Object, format As StreamingFormat)

Parameters:

  • name:
  • value:
  • format:

Write (String, Object, Type, StreamingFormat)    (declared in Serializer)

The general method for writing that calls specific WriteXXX method dependently on the type of an object to write.

 

method Write(name: String; value: Object; type: Type; format: StreamingFormat)

 

void Write(String name, Object value, Type type, StreamingFormat format)

 

Sub Write(name As String, value As Object, type As Type, format As StreamingFormat)

Parameters:

  • name:
  • value:
  • type:
  • format:

WriteAnsiString

 

method WriteAnsiString(name: String; value: String)

 

void WriteAnsiString(String name, String value)

 

Sub WriteAnsiString(name As String, value As String)

Parameters:

  • name:
  • value:

WriteArray

 

method WriteArray(name: String; value: Array; format: StreamingFormat)

 

void WriteArray(String name, Array value, StreamingFormat format)

 

Sub WriteArray(name As String, value As Array, format As StreamingFormat)

Parameters:

  • name:
  • value:
  • format:

WriteBinary

 

method WriteBinary(name: String; value: Stream)

 

void WriteBinary(String name, Stream value)

 

Sub WriteBinary(name As String, value As Stream)

Parameters:

  • name:
  • value:

WriteBoolean

 

method WriteBoolean(name: String; value: Boolean)

 

void WriteBoolean(String name, Boolean value)

 

Sub WriteBoolean(name As String, value As Boolean)

Parameters:

  • name:
  • value:

WriteComplex    (declared in Serializer)

 

method WriteComplex(name: String; value: ComplexType)

 

void WriteComplex(String name, ComplexType value)

 

Sub WriteComplex(name As String, value As ComplexType)

Parameters:

  • name:
  • value:

WriteCurrency

 

method WriteCurrency(name: String; value: Decimal)

 

void WriteCurrency(String name, Decimal value)

 

Sub WriteCurrency(name As String, value As Decimal)

Parameters:

  • name:
  • value:

WriteCustomEnum

 

method WriteCustomEnum(name: String; value: ICustomEnum)

 

void WriteCustomEnum(String name, ICustomEnum value)

 

Sub WriteCustomEnum(name As String, value As ICustomEnum)

Parameters:

  • name:
  • value:

WriteDateTime

 

method WriteDateTime(name: String; value: DateTime)

 

void WriteDateTime(String name, DateTime value)

 

Sub WriteDateTime(name As String, value As DateTime)

Parameters:

  • name:
  • value:

WriteDecimal

 

method WriteDecimal(name: String; value: Decimal)

 

void WriteDecimal(String name, Decimal value)

 

Sub WriteDecimal(name As String, value As Decimal)

Parameters:

  • name:
  • value:

WriteDouble

 

method WriteDouble(name: String; value: Double)

 

void WriteDouble(String name, Double value)

 

Sub WriteDouble(name As String, value As Double)

Parameters:

  • name:
  • value:

WriteEnum

 

method WriteEnum(name: String; value: Enum)

 

void WriteEnum(String name, Enum value)

 

Sub WriteEnum(name As String, value As Enum)

Parameters:

  • name:
  • value:

WriteGenericArray

 

method WriteGenericArray(name: String; value: IList; format: StreamingFormat)

 

void WriteGenericArray(String name, IList value, StreamingFormat format)

 

Sub WriteGenericArray(name As String, value As IList, format As StreamingFormat)

Parameters:

  • name:
  • value:
  • format:

WriteGuid

 

method WriteGuid(name: String; value: Guid)

 

void WriteGuid(String name, Guid value)

 

Sub WriteGuid(name As String, value As Guid)

Parameters:

  • name:
  • value:

WriteInt32

 

method WriteInt32(name: String; value: Int32)

 

void WriteInt32(String name, Int32 value)

 

Sub WriteInt32(name As String, value As Int32)

Parameters:

  • name:
  • value:

WriteInt64

 

method WriteInt64(name: String; value: Int64)

 

void WriteInt64(String name, Int64 value)

 

Sub WriteInt64(name As String, value As Int64)

Parameters:

  • name:
  • value:

WriteItem

Method is used in almost all WriteXXX methods of the class. It adds its input parameters as "key=value" to the inner string storage.

 

method WriteItem(name: String; value: String)

 

void WriteItem(String name, String value)

 

Sub WriteItem(name As String, value As String)

Parameters:

  • name:
  • value:

WriteNullableBoolean

 

method WriteNullableBoolean(name: String; value: Nullable<Boolean>)

 

void WriteNullableBoolean(String name, Nullable<Boolean> value)

 

Sub WriteNullableBoolean(name As String, value As Nullable<Boolean>)

Parameters:

  • name:
  • value:

WriteNullableCurrency

 

method WriteNullableCurrency(name: String; value: Nullable<Decimal>)

 

void WriteNullableCurrency(String name, Nullable<Decimal> value)

 

Sub WriteNullableCurrency(name As String, value As Nullable<Decimal>)

Parameters:

  • name:
  • value:

WriteNullableDateTime

 

method WriteNullableDateTime(name: String; value: Nullable<DateTime>)

 

void WriteNullableDateTime(String name, Nullable<DateTime> value)

 

Sub WriteNullableDateTime(name As String, value As Nullable<DateTime>)

Parameters:

  • name:
  • value:

WriteNullableDecimal

 

method WriteNullableDecimal(name: String; value: Nullable<Decimal>)

 

void WriteNullableDecimal(String name, Nullable<Decimal> value)

 

Sub WriteNullableDecimal(name As String, value As Nullable<Decimal>)

Parameters:

  • name:
  • value:

WriteNullableDouble

 

method WriteNullableDouble(name: String; value: Nullable<Double>)

 

void WriteNullableDouble(String name, Nullable<Double> value)

 

Sub WriteNullableDouble(name As String, value As Nullable<Double>)

Parameters:

  • name:
  • value:

WriteNullableEnum

 

method WriteNullableEnum(name: String; value: nullable Enum)

 

void WriteNullableEnum(String name, Enum? value)

 

Sub WriteNullableEnum(name As String, value As Enum?)

Parameters:

  • name:
  • value:

WriteNullableGuid

 

method WriteNullableGuid(name: String; value: Nullable<Guid>)

 

void WriteNullableGuid(String name, Nullable<Guid> value)

 

Sub WriteNullableGuid(name As String, value As Nullable<Guid>)

Parameters:

  • name:
  • value:

WriteNullableInt32

 

method WriteNullableInt32(name: String; value: Nullable<Int32>)

 

void WriteNullableInt32(String name, Nullable<Int32> value)

 

Sub WriteNullableInt32(name As String, value As Nullable<Int32>)

Parameters:

  • name:
  • value:

WriteNullableInt64

 

method WriteNullableInt64(name: String; value: Nullable<Int64>)

 

void WriteNullableInt64(String name, Nullable<Int64> value)

 

Sub WriteNullableInt64(name As String, value As Nullable<Int64>)

Parameters:

  • name:
  • value:

WriteObject    (declared in Serializer)

This method is a wrapper for Write method. It defines a type and streaming format of passed object.

 

method WriteObject(name: String; value: Object)

 

void WriteObject(String name, Object value)

 

Sub WriteObject(name As String, value As Object)

Parameters:

  • name:
  • value:

WriteObjectData    (declared in Serializer)

 

method WriteObjectData(value: Object)

 

void WriteObjectData(Object value)

 

Sub WriteObjectData(value As Object)

Parameters:

  • value:

WriteToStream

 

method WriteToStream(stream: Stream)

 

void WriteToStream(Stream stream)

 

Sub WriteToStream(stream As Stream)

Parameters:

  • stream:

WriteUtf8String

 

method WriteUtf8String(name: String; value: String)

 

void WriteUtf8String(String name, String value)

 

Sub WriteUtf8String(name As String, value As String)

Parameters:

  • name:
  • value:

WriteVariant

 

method WriteVariant(name: String; value: Object)

 

void WriteVariant(String name, Object value)

 

Sub WriteVariant(name As String, value As Object)

Parameters:

  • name:
  • value:

WriteWideString

 

method WriteWideString(name: String; value: String)

 

void WriteWideString(String name, String value)

 

Sub WriteWideString(name As String, value As String)

Parameters:

  • name:
  • value:

WriteXml

 

method WriteXml(name: String; value: XmlNode)

 

void WriteXml(String name, XmlNode value)

 

Sub WriteXml(name As String, value As XmlNode)

Parameters:

  • name:
  • value: