StringSafeDictionary<TValue> Class

Safe dictionary indexed by string

Inheritance Hierarchy

System.Object
  System.Collections.Hashtable
    CMS.Base.SafeDictionary<String, TValue>
      CMS.Base.StringSafeDictionary<TValue>
        CMS.Base.MultiKeyDictionary<ValueType>
        CMS.UIControls.UniGridTransformations

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

Syntax

[SerializableAttribute]
public class StringSafeDictionary<TValue> : SafeDictionary<string, TValue>

Type Parameters

TValue

The StringSafeDictionary<TValue> type exposes the following members.

Constructors

	Name	Description
Public method	StringSafeDictionary<TValue>()	Default constructor, creates case insensitive dictionary
Public method	StringSafeDictionary<TValue>(Boolean)	Constructor
Public method	StringSafeDictionary<TValue>(IDictionary, Boolean)	Constructor.
Public method	StringSafeDictionary<TValue>(IDictionary, IEqualityComparer)	Constructor.
Public method	StringSafeDictionary<TValue>(SerializationInfo, StreamingContext)	De-serialization constructor.

Fields

	Name	Description
Protected field	mDefaultValue	Default value. (Inherited from SafeDictionary<TKey, TValue>.)
Protected field	mNullValue	Null value. (Inherited from SafeDictionary<TKey, TValue>.)
Protected field	mUseWeakReferences	If true, the weak references are used for the items so the memory can be cleared upon request (Inherited from SafeDictionary<TKey, TValue>.)

Properties

	Name	Description
Public property	AllowNulls	If true, the dictionary allows null values as valid. (Inherited from SafeDictionary<TKey, TValue>.)
Public property	CopyToNewThread	If true, the dictionary is copied (not cloned) to a new thread (Inherited from SafeDictionary<TKey, TValue>.)
Public property	DefaultValue	Default value. (Inherited from SafeDictionary<TKey, TValue>.)
Public property	IsEmpty	Returns true if the dictionary is empty (Inherited from SafeDictionary<TKey, TValue>.)
Public property	IsSynchronized	Returns true if dictionary is synchronized. (Inherited from SafeDictionary<TKey, TValue>.)
Public property	Item[Object]	Items indexer. Gets or sets the value in the dictionary. (Inherited from SafeDictionary<TKey, TValue>.)
Public property	Item[TKey]	Items indexer. Gets or sets the value in the dictionary. (Inherited from SafeDictionary<TKey, TValue>.)
Public property	Keys	Gets an Collection containing the keys in the System.Collections.Hashtable. (Inherited from SafeDictionary<TKey, TValue>.)
Public property	NullValue	Null value. (Inherited from SafeDictionary<TKey, TValue>.)
Public property Code example	SyncRoot	Gets an object that can be used to synchronize access to the SafeDictionary<TKey, TValue>. (Inherited from SafeDictionary<TKey, TValue>.)
Public property	TypedKeys	Gets a typed collection of keys in this dictionary (Inherited from SafeDictionary<TKey, TValue>.)
Public property	TypedValues	Gets a typed collection of values in this dictionary (Inherited from SafeDictionary<TKey, TValue>.)
Public property Code example	UseWeakReferences	If true, the weak references are used for the items so the memory can be cleared upon request. The property can be set only when the dictionary is empty. To ensure thread-safety, you have to perform the check for emptiness and property assignment in a critical section (use SyncRoot for that purpose). (Inherited from SafeDictionary<TKey, TValue>.)
Public property	Values	Gets a Collection containing the values in the System.Collections.Hashtable. (Inherited from SafeDictionary<TKey, TValue>.)

Methods

	Name	Description
Public method Code example	Add	Adds the value to the dictionary if it does not exist. Updates existing, if it does exist. (Inherited from SafeDictionary<TKey, TValue>.)
Public method Code example	AddMultiple	Adds multiple items with same value to the dictionary (Inherited from SafeDictionary<TKey, TValue>.)
Public method	Clear	Removes all elements from the System.Collections.Hashtable. (Inherited from SafeDictionary<TKey, TValue>.)
Public method	Clone	Clones the dictionary (Overrides SafeDictionary<TKey, TValue>.Clone().)
Public method	CloneForNewThread	Clones the object for new thread (Inherited from SafeDictionary<TKey, TValue>.)
Public method	Contains	Returns true if the dictionary contains the given key (Inherited from SafeDictionary<TKey, TValue>.)
Public method	ContainsKey	Returns true if the dictionary contains the given key (Inherited from SafeDictionary<TKey, TValue>.)
Public method	ContainsValue	Returns true if the dictionary contains the given value (Inherited from SafeDictionary<TKey, TValue>.)
Protected method	CopyPropertiesTo	Copies the dictionary properties to the target dictionary (Inherited from SafeDictionary<TKey, TValue>.)
Public method Code example	CopyTo	Copies the System.Collections.Hashtable elements to a one-dimensional System.Array instance at the specified index. (Inherited from SafeDictionary<TKey, TValue>.)
Protected method	GetInternalValue	Gets the value from the internal dictionary (Inherited from SafeDictionary<TKey, TValue>.)
Public method	GetObjectData	Object serialization. (Inherited from SafeDictionary<TKey, TValue>.)
Public method Code example	GetRealCount	Gets the real count of the objects in the dictionary. (Inherited from SafeDictionary<TKey, TValue>.)
Public method	Remove	Removes the element with the specified key from the System.Collections.Hashtable. (Inherited from SafeDictionary<TKey, TValue>.)
Protected method	SetInternalValue	Sets the value in the internal dictionary (Inherited from SafeDictionary<TKey, TValue>.)
Public method	TryGetValue	Tries to get the value, returns true if the retrieval was successful. (Inherited from SafeDictionary<TKey, TValue>.)