ProviderDictionaryCollection Class

Collection of the provider dictionaries.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.ProviderDictionaryCollection

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

Syntax

public class ProviderDictionaryCollection

The ProviderDictionaryCollection type exposes the following members.

Constructors

	Name	Description
Public method	ProviderDictionaryCollection(String, LoadHashtableEnum, ProviderDictionaryCollection.LoadGenerationEventHandler)	Constructor.
Public method	ProviderDictionaryCollection(String, LoadHashtableEnum, ProviderDictionaryCollection.LoadGenerationParamsEventHandler, Object)	Constructor.

Methods

	Name	Description
Public method	Clear	Clears all the items.
Public method	LoadAll	Ensures loading of all the items. Keeps the original loading type.
Public method	LoadDefaultItems	Loads the default items of the dictionaries.
Public method	LoadGeneration	Loads specific generation of the objects.
Public method	LoadNextGeneration	Loads the next generation of the dictionaries.
Public method	NextGenerationAvailable	Returns true if the next generation of the objects is available.

Extension Methods

	Name	Description
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	mByCodeName	Code name dictionary.
Protected field	mByFullName	Full name dictionary.
Protected field	mByGuid	GUID dictionary.
Protected field	mByGuidAndSite	GUID and site ID dictionary.
Protected field	mById	ID dictionary.
Protected field Static member	mCollections	Hashtable of all dictionary collections.
Protected field	mLoadCollectionsAfterClear	Indicates if collection should be filled with new data after clearing the collection
Protected field	mLoadedGeneration	Currently loaded generation of the objects.
Protected field	mLoadingType	Default loading type of the items.
Protected field	mName	Dictionary name.
Protected field	mParameter	Custom parameter passed to a LoadGeneration method.
Protected field	mStringValues	Values dictionary.

Properties

	Name	Description
Public property	AllGenerationsLoaded	Returns true if all generations were loaded
Public property	ByCodeName	CodeName dictionary.
Public property	ByFullName	FullName dictionary.
Public property	ByGuid	Guid dictionary.
Public property	ByGuidAndSite	Guid and site dictionary.
Public property	ById	ID dictionary.
Public property Static member	Collections	Hashtable of all dictionary collections.
Public property	LoadCollectionsAfterClear	Indicates if collection should be filled with new data after clearing the collection
Public property	LoadedGeneration	Returns the number of the loaded generation of the objects.
Public property	Name	Dictionary name.
Public property	Parameter	Custom parameter passed to a LoadGeneration method.
Public property	StringValues	String values dictionary.

Events

	Name	Description
Public event	OnLoadGeneration	Event which is called when loading of specific generation is requested.
Public event	OnLoadGenerationParams	Event which is called when loading of specific generation is requested with additional custom parameter.