SafeDictionary<TKey, TValue> Class

Thread safe dictionary template.

Inheritance Hierarchy

System.Object
  System.Collections.Hashtable
    CMS.Base.SafeDictionary<TKey, TValue>
      CMS.Base.StringSafeDictionary<TValue>
      CMS.Base.ThreadItemsDictionary

Namespace: CMS.Base
Assembly: CMS.Base (in CMS.Base.dll) Version: 8.2.23

Syntax

[SerializableAttribute]
public class SafeDictionary<TKey, TValue> : Hashtable, 
	ICloneThreadItem, IXmlSerializable, IGeneralIndexable<TKey, TValue>, IGeneralIndexable

Type Parameters

TKey

Key type

TValue

Value type

The SafeDictionary<TKey, TValue> type exposes the following members.

Constructors

	Name	Description
Public method	SafeDictionary<TKey, TValue>()	SafeDictionary constructor.
Public method	SafeDictionary<TKey, TValue>(IEqualityComparer)	SafeDictionary constructor.
Public method	SafeDictionary<TKey, TValue>(IDictionary, IEqualityComparer)	Constructor.
Public method	SafeDictionary<TKey, TValue>(SerializationInfo, StreamingContext)	De-serialization constructor.

Methods

	Name	Description
Public method	Add	Adds the value to the dictionary (Overrides Hashtable.Add(Object, Object).)
Public method	AddMultiple	Adds multiple items with same value to the dictionary
Public method	Clear	Removes all elements from the System.Collections.Hashtable. (Overrides Hashtable.Clear().)
Public method	CloneForNewThread	Clones the object for new thread
Public method	Contains	Returns true if the dictionary contains the given key (Overrides Hashtable.Contains(Object).)
Public method	ContainsKey	Returns true if the dictionary contains the given key (Overrides Hashtable.ContainsKey(Object).)
Public method	ContainsValue	Returns true if the dictionary contains the given value (Overrides Hashtable.ContainsValue(Object).)
Public method	CopyTo	Copies the System.Collections.Hashtable elements to a one-dimensional System.Array instance at the specified index. (Overrides Hashtable.CopyTo(Array, Int32).)
Protected method	GetInternalValue	Gets the value from the internal dictionary
Public method	GetObjectData	Object serialization. (Overrides Hashtable.GetObjectData(SerializationInfo, StreamingContext).)
Public method	GetRealCount	Gets the real count of the objects in the dictionary
Public method	Remove	Removes the element with the specified key from the System.Collections.Hashtable. (Overrides Hashtable.Remove(Object).)
Protected method	SetInternalValue	Sets the value in the internal dictionary
Public method	TryGetValue	Tries to get the value, returns true if the retrieval was successful.

Extension Methods

	Name	Description
Public Extension Method	AsIndexable<TKey, TValue>	Implicit conversion to indexable type with a specific values (Defined by DataExtensions.)
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field	mDefaultValue	Default value.
Protected field	mNullValue	Null value.
Protected field	mUseWeakReferences	If true, the weak references are used for the items so the memory can be cleared upon request

Properties

	Name	Description
Public property	AllowNulls	If true, the dictionary allows null values as valid.
Public property	CopyToNewThread	If true, the dictionary is copied (not cloned) to a new thread
Public property	DefaultValue	Default value.
Public property	IsEmpty	Returns true if the dictionary is empty
Public property	IsSynchronized	Returns true if dictionary is synchronized. (Overrides Hashtable.IsSynchronized.)
Public property	Item	Items indexer. Gets or sets the value in the dictionary.
Public property	Keys	Gets an Collection containing the keys in the System.Collections.Hashtable. (Overrides Hashtable.Keys.)
Public property	NullValue	Null value.
Public property	TypedKeys	Gets a typed collection of keys in this dictionary
Public property	TypedValues	Gets a typed collection of values in this dictionary
Public property	UseWeakReferences	If true, the weak references are used for the items so the memory can be cleared upon request
Public property	Values	Gets an Collection containing the values in the System.Collections.Hashtable. (Overrides Hashtable.Values.)