ProviderStringDictionary Class

Provider string indexed dictionary.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractProviderDictionary
    CMS.DataEngine.ProviderDictionary<String, BaseInfo>
      CMS.DataEngine.ProviderInfoDictionary<String>
        CMS.DataEngine.ProviderStringDictionary

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 10.0.0

Syntax

public class ProviderStringDictionary : ProviderInfoDictionary<string>

The ProviderStringDictionary type exposes the following members.

Constructors

	Name	Description
Public method	ProviderStringDictionary	Constructor.

Properties

	Name	Description
Public property	ColumnNames	Column names (Inherited from ProviderDictionary<TKey, TValue>.)
Public property	Count	Items count (all keys). (Inherited from ProviderDictionary<TKey, TValue>.)
Public property	DataIsValid	Returns true if the dictionary content is valid. (Inherited from ProviderDictionary<TKey, TValue>.)
Public property	Enabled	If true, the dictionary is enabled. (Inherited from ProviderDictionary<TKey, TValue>.)
Public property	IsEmpty	Returns true if the Dictionary is empty. (Inherited from ProviderDictionary<TKey, TValue>.)
Public property	Item	Dictionary indexer. (Inherited from ProviderDictionary<TKey, TValue>.)
Public property	LogWebFarmTasks	Gets / sets if the dictionary should log web farm tasks (Inherited from ProviderDictionary<TKey, TValue>.)
Public property	Name	Dictionary name. (Inherited from ProviderDictionary<TKey, TValue>.)
Public property	ObjectType	Object type (Inherited from ProviderDictionary<TKey, TValue>.)
Public property	ParentCollection	Parent dictionary collection. (Inherited from ProviderDictionary<TKey, TValue>.)
Public property	UseWeakReferences	If true, the weak references are used for the items so the memory can be cleared upon request (Inherited from ProviderDictionary<TKey, TValue>.)
Protected property	WebFarmTaskOperation	Web farm task operation identificator used in task queue. (Inherited from ProviderDictionary<TKey, TValue>.)

Methods

	Name	Description
Public method	Add(TKey, TValue)	Adds the specified object. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	Add(KeyType, BaseInfo, Boolean)	Adds the specified object. (Inherited from ProviderInfoDictionary<KeyType>.)
Public method	Clear	Clears all the items. (Inherited from ProviderDictionary<TKey, TValue>.)
Protected method	ClearInternal	Clears the internal dictionary (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	Contains(Object)	Returns true if the table contains specified record. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	Contains(TKey)	Returns true if the table contains specified record. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	Contains(Object, TValue)	Returns true if the table contains specified record. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	Contains(TKey, TValue)	Returns true if the table contains specified record. (Inherited from ProviderDictionary<TKey, TValue>.)
Protected method	ContainsInternal	Returns true if the internal dictionary contains specified record. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	ContainsKey	Returns true if the table contains specified record. (Inherited from ProviderDictionary<TKey, TValue>.)
Protected method	ConvertKey	Converts the key to a specific type (Overrides ProviderDictionary<TKey, TValue>.ConvertKey(Object).)
Public method	Delete	Removes the specified object and logs the web farm task. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	Invalidate	Invalidates the dictionary content. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	LoadNextGeneration	Loads the next generation of the objects. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	LogWebFarmTask(String, String)	Logs the web farm task with specified task data. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	NextGenerationAvailable	Returns true if the next generation of the objects is available. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	Remove(Object)	Removes the specified object. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	Remove(TKey)	Removes the specified object. (Inherited from ProviderDictionary<TKey, TValue>.)
Public method	Remove(TKey, Boolean)	Removes the specified object. (Inherited from ProviderDictionary<TKey, TValue>.)
Protected method	RemoveInternal	Removes the key from the internal dictionary (Inherited from ProviderDictionary<TKey, TValue>.)
Protected method	TryGetInternal	Returns true if the internal dictionary contains specified record. (Inherited from ProviderInfoDictionary<KeyType>.)
Public method	Update	Updates the specified object and logs the web farm task. (Inherited from ProviderDictionary<TKey, TValue>.)