MultiKeyDictionary<ValueType> Class

Hashtable which can use multiple keys to access the same data. The keys are separated by the separator.

Inheritance Hierarchy

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

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

Syntax

public class MultiKeyDictionary<ValueType> : StringSafeDictionary<ValueType>

Type Parameters

ValueType

The MultiKeyDictionary<ValueType> type exposes the following members.

Constructors

	Name	Description
Public method	MultiKeyDictionary<ValueType>()	Default constructor.
Public method	MultiKeyDictionary<ValueType>(IDictionary)	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	IsSynchronized	Returns true if dictionary is synchronized. (Inherited from SafeDictionary<TKey, TValue>.)
Public property	Item[Object]	Gets or sets the value associated with key value (Overrides SafeDictionary<TKey, TValue>.Item[Object].)
Public property	Item[String]	Gets or sets the item. (Overrides SafeDictionary<TKey, TValue>.Item[TKey].)
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	Add	Adds the value to the table. (Overrides SafeDictionary<TKey, TValue>.Add(Object, Object).)
Public method Code example	AddMultiple	Adds multiple items with same value to the dictionary (Inherited from SafeDictionary<TKey, TValue>.)
Public method	Clear	Clears the table. (Overrides SafeDictionary<TKey, TValue>.Clear().)
Public method	Clone	Gets the cloned Hashtable. (Overrides StringSafeDictionary<TValue>.Clone().)
Public method	CloneForNewThread	Clones the object for new thread (Inherited from SafeDictionary<TKey, TValue>.)
Public method	Contains	Returns true if the table contains specific key. (Overrides SafeDictionary<TKey, TValue>.Contains(Object).)
Public method	ContainsKey	Returns true if the table contains specific key. (Overrides SafeDictionary<TKey, TValue>.ContainsKey(Object).)
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>.)
Protected method	GetMainKey	Gets the main object key for the given key.
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 item from the table. (Overrides SafeDictionary<TKey, TValue>.Remove(Object).)
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>.)

Remarks

This API supports the framework infrastructure and is not intended to be used directly from your code.