AgateLib.Serialization.Xle.XleSerializationInfo Class Reference

The XleSerializationInfo class contains the XML data that is read from or written to when doing XLE serialization. More...

List of all members.

Public Member Functions
void	Write (string name, string value)
	Writes a field to the XML data as an element.
void	Write (string name, double value)
	Writes a field to the XML data as an element.
void	Write (string name, float value)
	Writes a field to the XML data as an element.
void	Write (string name, bool value)
	Writes a field to the XML data as an element.
void	Write (string name, char value)
	Writes a field to the XML data as an element.
void	Write (string name, short value)
	Writes a field to the XML data as an element.
void	Write (string name, int value)
	Writes a field to the XML data as an element.
void	Write (string name, long value)
	Writes a field to the XML data as an element.
void	Write (string name, decimal value)
	Writes a field to the XML data as an element.
void	Write (string name, string value, bool asAttribute)
	Writes a field to the XML data as an element or an attribute.
void	Write (string name, double value, bool asAttribute)
	Writes a field to the XML data as an element or an attribute.
void	Write (string name, float value, bool asAttribute)
	Writes a field to the XML data as an element or an attribute.
void	Write (string name, bool value, bool asAttribute)
	Writes a field to the XML data as an element or an attribute.
void	Write (string name, char value, bool asAttribute)
	Writes a field to the XML data as an element or an attribute.
void	Write (string name, short value, bool asAttribute)
	Writes a field to the XML data as an element or an attribute.
void	Write (string name, int value, bool asAttribute)
	Writes a field to the XML data as an element or an attribute.
void	Write (string name, long value, bool asAttribute)
	Writes a field to the XML data as an element or an attribute.
void	Write (string name, decimal value, bool asAttribute)
	Writes a field to the XML data as an element or an attribute.
void	Write (string name, int[] value)
	Writes an int[] array to the XML data as an element.
void	Write (string name, double[] value)
	Writes an double[] array to the XML data as an element.
void	Write (string name, byte[] value)
	Writes a byte[] array to the XML data as an element.
void	Write (string name, IXleSerializable value)
	Writes an object implementing IXleSerializable to the XML data as an element.
void	Write< T > (string name, T[] value)
	Writes an array of objects implementing IXleSerializable to the XML data as an element.
void	Write< T > (string name, List< T > value)
	Writes a List<T> of objects implementing IXleSerializable to the XML data as an element.
void	Write< Tkey, Tvalue > (string name, Dictionary< Tkey, Tvalue > value)
	Writes a Dictionary of objects implementing IXleSerializable to the XML data as an element. The key type must implement IConvertible and the value type must implment IXleSerializable.
void	Write< Tkey > (string name, Dictionary< Tkey, string > value)
	Writes a Dictionary of strings implementing IXleSerializable to the XML data as an element. The key type must implement IConvertible.
Dictionary< TKey, TValue >	ReadDictionary< TKey, TValue > (string name)
	Reads a dictionary type from the XML data. The key type must implement IConvertible and the value type must implement IXleSerializable.
Dictionary< Tkey, string >	ReadDictionary< Tkey > (string name)
	Reads a dictionary type of strings from the XML data. The key type must implement IConvertible and the value type must implement IXleSerializable.
object	ReadObject (string name)
	Reads an object from the XML data.
string	ReadString (string name, string defaultValue)
	Reads a string from the XML data, with an optional default value substituted if the name is not present.
string	ReadString (string name)
	Reads a string from the XML data. If the name is not present an XleSerializationException is thrown.
bool	ReadBoolean (string name)
	Reads a boolean value from the XML data. If the name is not present an XleSerializationException is thrown.
int	ReadInt32 (string name)
	Reads a integer value from the XML data. If the name is not present an XleSerializationException is thrown.
int	ReadInt32 (string name, int defaultValue)
	Reads a integer value from the XML data. If the name is not present the default value is returned.
double	ReadDouble (string name)
	Reads a double value from the XML data. If the name is not present an XleSerializationException is thrown.
int[]	ReadInt32Array (string name)
	Reads a integer array from the XML data. If the name is not present an XleSerializationException is thrown.
double[]	ReadDoubleArray (string name)
	Reads a double array from the XML data. If the name is not present an XleSerializationException is thrown.
T[]	ReadArray< T > (string name)
	Reads an array of objects from the XML data. If the name is not present an XleSerializationException is thrown.
List< T >	ReadList< T > (string name)
	Reads a list of objects from the XML data. If the name is not present an XleSerializationException is thrown.
byte[]	ReadByteArray (string name)
	Reads a byte array from the XML data. If the name is not present an XleSerializationException is thrown.
Properties
ITypeBinder	Binder [get, set]
	The ITypeBinder object used.

---

Detailed Description

The XleSerializationInfo class contains the XML data that is read from or written to when doing XLE serialization.

---

Member Function Documentation

T [] AgateLib.Serialization.Xle.XleSerializationInfo.ReadArray< T >

(

string

name

)

Reads an array of objects from the XML data. If the name is not present an XleSerializationException is thrown.

Parameters:

name

Name of the field.

Returns:

bool AgateLib.Serialization.Xle.XleSerializationInfo.ReadBoolean

(

string

name

)

Reads a boolean value from the XML data. If the name is not present an XleSerializationException is thrown.

Parameters:

name

Name of the field.

Returns:

byte [] AgateLib.Serialization.Xle.XleSerializationInfo.ReadByteArray

(

string

name

)

Reads a byte array from the XML data. If the name is not present an XleSerializationException is thrown.

Parameters:

name

Name of the field.

Returns:

Dictionary<Tkey, string> AgateLib.Serialization.Xle.XleSerializationInfo.ReadDictionary< Tkey >

(

string

name

)

Reads a dictionary type of strings from the XML data. The key type must implement IConvertible and the value type must implement IXleSerializable.

Template Parameters:

Tkey

The key type of the dictionary.

Parameters:

name

The name of the element in the XML stream to decode.

Returns:

Type Constraints

Tkey

:

IConvertible

Dictionary<TKey, TValue> AgateLib.Serialization.Xle.XleSerializationInfo.ReadDictionary< TKey, TValue >

(

string

name

)

Reads a dictionary type from the XML data. The key type must implement IConvertible and the value type must implement IXleSerializable.

Template Parameters:

	TKey
	TValue

Parameters:

name

Returns:

Type Constraints

TKey	:	IConvertible
TValue	:	IXleSerializable

double AgateLib.Serialization.Xle.XleSerializationInfo.ReadDouble

(

string

name

)

Reads a double value from the XML data. If the name is not present an XleSerializationException is thrown.

Parameters:

name

Name of the field.

Returns:

double [] AgateLib.Serialization.Xle.XleSerializationInfo.ReadDoubleArray

(

string

name

)

Reads a double array from the XML data. If the name is not present an XleSerializationException is thrown.

Parameters:

name

Name of the field.

Returns:

int AgateLib.Serialization.Xle.XleSerializationInfo.ReadInt32	(	string	name,
		int	defaultValue
	)

Reads a integer value from the XML data. If the name is not present the default value is returned.

Parameters:

	name	Name of the field.
	defaultValue	The default value to return if the name is not present.

Returns:

int AgateLib.Serialization.Xle.XleSerializationInfo.ReadInt32

(

string

name

)

Reads a integer value from the XML data. If the name is not present an XleSerializationException is thrown.

Parameters:

name

Name of the field.

Returns:

int [] AgateLib.Serialization.Xle.XleSerializationInfo.ReadInt32Array

(

string

name

)

Reads a integer array from the XML data. If the name is not present an XleSerializationException is thrown.

Parameters:

name

Name of the field.

Returns:

List<T> AgateLib.Serialization.Xle.XleSerializationInfo.ReadList< T >

(

string

name

)

Reads a list of objects from the XML data. If the name is not present an XleSerializationException is thrown.

Parameters:

name

Name of the field.

Returns:

object AgateLib.Serialization.Xle.XleSerializationInfo.ReadObject

(

string

name

)

Reads an object from the XML data.

Parameters:

name

Returns:

string AgateLib.Serialization.Xle.XleSerializationInfo.ReadString

(

string

name

)

Reads a string from the XML data. If the name is not present an XleSerializationException is thrown.

Parameters:

name

The name of the XML field to decode.

Returns:

string AgateLib.Serialization.Xle.XleSerializationInfo.ReadString	(	string	name,
		string	defaultValue
	)

Reads a string from the XML data, with an optional default value substituted if the name is not present.

Parameters:

	name
	defaultValue

Returns:

void AgateLib.Serialization.Xle.XleSerializationInfo.Write	(	string	name,
		IXleSerializable	value
	)

Writes an object implementing IXleSerializable to the XML data as an element.

Parameters:

	name	The name of the XML element used.
	value	The object data to write.

void AgateLib.Serialization.Xle.XleSerializationInfo.Write	(	string	name,
		byte[]	value
	)

Writes a byte[] array to the XML data as an element.

Parameters:

	name	The name of the XML element used.
	value	The array data to write.

void AgateLib.Serialization.Xle.XleSerializationInfo.Write	(	string	name,
		double[]	value
	)

Writes an double[] array to the XML data as an element.

Parameters:

	name	The name of the XML element used.
	value	The array data to write.

void AgateLib.Serialization.Xle.XleSerializationInfo.Write	(	string	name,
		int[]	value
	)

Writes an int[] array to the XML data as an element.

Parameters:

	name	The name of the XML element used.
	value	The array data to write.

void AgateLib.Serialization.Xle.XleSerializationInfo.Write	(	string	name,
		decimal	value,
		bool	asAttribute
	)

Writes a field to the XML data as an element or an attribute.

Parameters:

	name	The name of the XML element used.
	value	The value to write.
	asAttribute	Pass true to write the field as an attribute in the parent element.

void AgateLib.Serialization.Xle.XleSerializationInfo.Write	(	string	name,
		long	value,
		bool	asAttribute
	)

Writes a field to the XML data as an element or an attribute.

Parameters:

	name	The name of the XML element used.
	value	The value to write.
	asAttribute	Pass true to write the field as an attribute in the parent element.

void AgateLib.Serialization.Xle.XleSerializationInfo.Write	(	string	name,
		int	value,
		bool	asAttribute
	)

Writes a field to the XML data as an element or an attribute.

Parameters:

	name	The name of the XML element used.
	value	The value to write.
	asAttribute	Pass true to write the field as an attribute in the parent element.

void AgateLib.Serialization.Xle.XleSerializationInfo.Write	(	string	name,
		short	value,
		bool	asAttribute
	)

Writes a field to the XML data as an element or an attribute.

Parameters:

	name	The name of the XML element used.
	value	The value to write.
	asAttribute	Pass true to write the field as an attribute in the parent element.

void AgateLib.Serialization.Xle.XleSerializationInfo.Write	(	string	name,
		char	value,
		bool	asAttribute
	)

Writes a field to the XML data as an element or an attribute.

Parameters:

	name	The name of the XML element used.
	value	The value to write.
	asAttribute	Pass true to write the field as an attribute in the parent element.

void AgateLib.Serialization.Xle.XleSerializationInfo.Write	(	string	name,
		bool	value,
		bool	asAttribute
	)

Writes a field to the XML data as an element or an attribute.

Parameters:

	name	The name of the XML element used.
	value	The value to write.
	asAttribute	Pass true to write the field as an attribute in the parent element.

void AgateLib.Serialization.Xle.XleSerializationInfo.Write	(	string	name,
		float	value,
		bool	asAttribute
	)

Writes a field to the XML data as an element or an attribute.

Parameters:

	name	The name of the XML element used.
	value	The value to write.
	asAttribute	Pass true to write the field as an attribute in the parent element.

void AgateLib.Serialization.Xle.XleSerializationInfo.Write	(	string	name,
		double	value,
		bool	asAttribute
	)

Writes a field to the XML data as an element or an attribute.

Parameters:

	name	The name of the XML element used.
	value	The value to write.
	asAttribute	Pass true to write the field as an attribute in the parent element.

void AgateLib.Serialization.Xle.XleSerializationInfo.Write	(	string	name,
		string	value,
		bool	asAttribute
	)

Writes a field to the XML data as an element or an attribute.

Parameters:

	name	The name of the XML element used.
	value	The value to write.
	asAttribute	Pass true to write the field as an attribute in the parent element.

void AgateLib.Serialization.Xle.XleSerializationInfo.Write	(	string	name,
		decimal	value
	)

Writes a field to the XML data as an element.

Parameters:

	name	The name of the XML element used.
	value	The value to write.

void AgateLib.Serialization.Xle.XleSerializationInfo.Write	(	string	name,
		long	value
	)

Writes a field to the XML data as an element.

Parameters:

	name	The name of the XML element used.
	value	The value to write.

void AgateLib.Serialization.Xle.XleSerializationInfo.Write	(	string	name,
		int	value
	)

Writes a field to the XML data as an element.

Parameters:

	name	The name of the XML element used.
	value	The value to write.

void AgateLib.Serialization.Xle.XleSerializationInfo.Write	(	string	name,
		short	value
	)

Writes a field to the XML data as an element.

Parameters:

	name	The name of the XML element used.
	value	The value to write.

void AgateLib.Serialization.Xle.XleSerializationInfo.Write	(	string	name,
		char	value
	)

Writes a field to the XML data as an element.

Parameters:

	name	The name of the XML element used.
	value	The value to write.

void AgateLib.Serialization.Xle.XleSerializationInfo.Write	(	string	name,
		bool	value
	)

Writes a field to the XML data as an element.

Parameters:

	name	The name of the XML element used.
	value	The value to write.

void AgateLib.Serialization.Xle.XleSerializationInfo.Write	(	string	name,
		float	value
	)

Writes a field to the XML data as an element.

Parameters:

	name	The name of the XML element used.
	value	The value to write.

void AgateLib.Serialization.Xle.XleSerializationInfo.Write	(	string	name,
		double	value
	)

Writes a field to the XML data as an element.

Parameters:

	name	The name of the XML element used.
	value	The value to write.

void AgateLib.Serialization.Xle.XleSerializationInfo.Write	(	string	name,
		string	value
	)

Writes a field to the XML data as an element.

Parameters:

	name	The name of the XML element used.
	value	The value to write.

void AgateLib.Serialization.Xle.XleSerializationInfo.Write< T >	(	string	name,
		List< T >	value
	)

Writes a List<T> of objects implementing IXleSerializable to the XML data as an element.

Parameters:

	name	The name of the XML element used.
	value	The list data to write.

Type Constraints

T

:

IXleSerializable

void AgateLib.Serialization.Xle.XleSerializationInfo.Write< T >	(	string	name,
		T[]	value
	)

Writes an array of objects implementing IXleSerializable to the XML data as an element.

Parameters:

	name	The name of the XML element used.
	value	The array data to write.

Type Constraints

T

:

IXleSerializable

void AgateLib.Serialization.Xle.XleSerializationInfo.Write< Tkey >	(	string	name,
		Dictionary< Tkey, string >	value
	)

Writes a Dictionary of strings implementing IXleSerializable to the XML data as an element. The key type must implement IConvertible.

Parameters:

	name	The name of the XML element used.
	value	The dictionary to write.

Type Constraints

Tkey

:

IConvertible

void AgateLib.Serialization.Xle.XleSerializationInfo.Write< Tkey, Tvalue >	(	string	name,
		Dictionary< Tkey, Tvalue >	value
	)

Writes a Dictionary of objects implementing IXleSerializable to the XML data as an element. The key type must implement IConvertible and the value type must implment IXleSerializable.

Parameters:

	name	The name of the XML element used.
	value	The dictionary to write.

Type Constraints

Tkey	:	IConvertible
Tvalue	:	IXleSerializable

---

Property Documentation

ITypeBinder AgateLib.Serialization.Xle.XleSerializationInfo.Binder [get, set]

The ITypeBinder object used.

---

The documentation for this class was generated from the following file:

• Serialization/Xle/XleSerializationInfo.cs