Table of Contents

Class ProviderDictionaryCollection

Namespace
CMS.DataEngine
Assembly
CMS.DataEngine.dll

Collection of the provider dictionaries.

public class ProviderDictionaryCollection
Inheritance
object
ProviderDictionaryCollection
Extension Methods

Constructors

ProviderDictionaryCollection(string, LoadHashtableEnum, Action<ProviderDictionaryCollection, object>, object)

Constructor.

public ProviderDictionaryCollection(string objectType, LoadHashtableEnum loadingType, Action<ProviderDictionaryCollection, object> loadCallback, object parameter = null)

Parameters

objectType string

Object type

loadingType LoadHashtableEnum

Loading type

loadCallback Action<ProviderDictionaryCollection, object>

Callback function with parameter to load the objects

parameter object

Additional parameter passed to the loadCallback

Exceptions

ArgumentNullException

objectType

ArgumentNullException

loadCallback

Properties

ByCodeName

CodeName dictionary.

public ProviderInfoDictionary<string> ByCodeName { get; set; }

Property Value

ProviderInfoDictionary<string>

ByFullName

FullName dictionary.

public ProviderInfoDictionary<string> ByFullName { get; set; }

Property Value

ProviderInfoDictionary<string>

ByGuid

Guid dictionary.

public ProviderInfoDictionary<Guid> ByGuid { get; set; }

Property Value

ProviderInfoDictionary<Guid>

ById

ID dictionary.

public ProviderInfoDictionary<int> ById { get; set; }

Property Value

ProviderInfoDictionary<int>

Name

Dictionary name.

public string Name { get; set; }

Property Value

string

StringValues

String values dictionary.

public ProviderDictionary<string, string> StringValues { get; set; }

Property Value

ProviderDictionary<string, string>

Methods

Clear(bool)

Clears all the items.

public void Clear(bool logTasks)

Parameters

logTasks bool

If true, web farm tasks are logged

LoadAll()

Ensures loading of all the items. Keeps the original loading type.

[Obsolete("Method is deprecated and will be removed in the next version.")]
[ObsoleteSince(27, 0)]
public void LoadAll()

LoadDefaultItems()

Loads the default items of the dictionaries.

public void LoadDefaultItems()