Click or drag to resize
ProviderDictionaryCollection Class
Collection of the provider dictionaries.
Inheritance Hierarchy
SystemObject
  CMS.DataEngineProviderDictionaryCollection

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 8.2.23
Syntax
C#
public class ProviderDictionaryCollection

The ProviderDictionaryCollection type exposes the following members.

Constructors
Methods
  NameDescription
Public methodClear
Clears all the items.
Public methodLoadAll
Ensures loading of all the items. Keeps the original loading type.
Public methodLoadDefaultItems
Loads the default items of the dictionaries.
Public methodLoadGeneration
Loads specific generation of the objects.
Public methodLoadNextGeneration
Loads the next generation of the dictionaries.
Public methodNextGenerationAvailable
Returns true if the next generation of the objects is available.
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Fields
  NameDescription
Protected fieldmByCodeName
Code name dictionary.
Protected fieldmByFullName
Full name dictionary.
Protected fieldmByGuid
GUID dictionary.
Protected fieldmByGuidAndSite
GUID and site ID dictionary.
Protected fieldmById
ID dictionary.
Protected fieldStatic membermCollections
Hashtable of all dictionary collections.
Protected fieldmLoadCollectionsAfterClear
Indicates if collection should be filled with new data after clearing the collection
Protected fieldmLoadedGeneration
Currently loaded generation of the objects.
Protected fieldmLoadingType
Default loading type of the items.
Protected fieldmName
Dictionary name.
Protected fieldmParameter
Custom parameter passed to a LoadGeneration method.
Protected fieldmStringValues
Values dictionary.
Top
Properties
  NameDescription
Public propertyAllGenerationsLoaded
Returns true if all generations were loaded
Public propertyByCodeName
CodeName dictionary.
Public propertyByFullName
FullName dictionary.
Public propertyByGuid
Guid dictionary.
Public propertyByGuidAndSite
Guid and site dictionary.
Public propertyById
ID dictionary.
Public propertyStatic memberCollections
Hashtable of all dictionary collections.
Public propertyLoadCollectionsAfterClear
Indicates if collection should be filled with new data after clearing the collection
Public propertyLoadedGeneration
Returns the number of the loaded generation of the objects.
Public propertyName
Dictionary name.
Public propertyParameter
Custom parameter passed to a LoadGeneration method.
Public propertyStringValues
String values dictionary.
Top
Events
  NameDescription
Public eventOnLoadGeneration
Event which is called when loading of specific generation is requested.
Public eventOnLoadGenerationParams
Event which is called when loading of specific generation is requested with additional custom parameter.
Top
See Also