VideoOS.Platform.Client.PropertyClass Class Reference

Abstract class incapsulating a key-value based property list.
More...

Inheritance diagram for VideoOS.Platform.Client.PropertyClass:

Public Member Functions
void	ClearProperties ()
	Clear property table.
virtual void	Deserialize (XmlNode xmlNode)
	Deserializes the class item from xml format.
string	GetProperty (string key)
	Gets a named (key) property value from the property list. Null is returned of the property does not exists.
ICollection	GetPropertyKeys ()
	Gets all the keys in the property collection.
object	GetTemporaryProperty (string key)
	Gets a named (key) temporary property value from the property list. Null is returned of the property does not exists.
	PropertyClass ()
	Constructs a PropertyClass item.
virtual void	Serialize (System.Xml.XmlTextWriter xmlTextWriter)
	Serializes the class item into xml format.
virtual String	SerializeToString ()
	Create a XmlNode containing the property dictionary, returned as a String.
virtual XmlNode	SerializeToXmlNode ()
	Create a XmlNode containing the property dictionary, returned as a String.
void	SetProperty (string key, string value)
	Sets a named (key) property value in the property list. The property value is updated if the property exists.
void	SetTemporaryProperty (string key, object value)
	Sets a named (key) temporary property value in the property list. The property value is updated if the property exists. Temporary will not be serialized (stored)

Protected Attributes
SortedList	_properties = new SortedList()
	The key-value collection holding the properties.
SortedList	_temporaryProperties = new SortedList()
	The key-value collection holding the temporary properties. Temporary will not be serialized (stored)

Detailed Description

Abstract class incapsulating a key-value based property list.

Constructor & Destructor Documentation

PropertyClass()

VideoOS.Platform.Client.PropertyClass.PropertyClass ( )

inline

Constructs a PropertyClass item.

Member Function Documentation

ClearProperties()

void VideoOS.Platform.Client.PropertyClass.ClearProperties ( )

inline

Clear property table.

Deserialize()

virtual void VideoOS.Platform.Client.PropertyClass.Deserialize ( XmlNode xmlNode )

inlinevirtual

Deserializes the class item from xml format.

Parameters

xmlNode

XmlNode containing the initialization xml

Reimplemented in VideoOS.Platform.Client.ViewItemManager.

GetProperty()

string VideoOS.Platform.Client.PropertyClass.GetProperty ( string key )

inline

Gets a named (key) property value from the property list. Null is returned of the property does not exists.

Parameters

key	The key of the property to get

Returns

The value of the property

GetPropertyKeys()

ICollection VideoOS.Platform.Client.PropertyClass.GetPropertyKeys ( )

inline

Gets all the keys in the property collection.

Returns

GetTemporaryProperty()

object VideoOS.Platform.Client.PropertyClass.GetTemporaryProperty ( string key )

inline

Gets a named (key) temporary property value from the property list. Null is returned of the property does not exists.

Parameters

key	The key of the temporary property to get

Returns

The value of the temporary property

Serialize()

virtual void VideoOS.Platform.Client.PropertyClass.Serialize ( System.Xml.XmlTextWriter xmlTextWriter )

inlinevirtual

Serializes the class item into xml format.

Parameters

xmlTextWriter

XmlTextWriter that the class item is serialized to

Reimplemented in VideoOS.Platform.Client.ViewItemManager.

SerializeToString()

virtual String VideoOS.Platform.Client.PropertyClass.SerializeToString ( )

inlinevirtual

Create a XmlNode containing the property dictionary, returned as a String.

Returns

SerializeToXmlNode()

virtual XmlNode VideoOS.Platform.Client.PropertyClass.SerializeToXmlNode ( )

inlinevirtual

Create a XmlNode containing the property dictionary, returned as a String.

Returns

SetProperty()

void VideoOS.Platform.Client.PropertyClass.SetProperty ( string key, string value )

inline

Sets a named (key) property value in the property list. The property value is updated if the property exists.

Parameters

key	The key of the property to set
value	The value of the property to set

Setting a value of null will remove the setting from the dictionary

SetTemporaryProperty()

void VideoOS.Platform.Client.PropertyClass.SetTemporaryProperty ( string key, object value )

inline

Sets a named (key) temporary property value in the property list. The property value is updated if the property exists. Temporary will not be serialized (stored)

Parameters

key	The key of the temporary property to set
value	The value of the temporary property to set

Member Data Documentation

_properties

SortedList VideoOS.Platform.Client.PropertyClass._properties = new SortedList()

protected

The key-value collection holding the properties.

_temporaryProperties

SortedList VideoOS.Platform.Client.PropertyClass._temporaryProperties = new SortedList()

protected

The key-value collection holding the temporary properties. Temporary will not be serialized (stored)