SettingsKeyInfoProvider Class

Provides access to settings keys.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractProvider
    CMS.DataEngine.BaseAbstractInfoProvider
      CMS.DataEngine.AbstractInfoProvider<SettingsKeyInfoProvider>
        CMS.DataEngine.AbstractInfoProvider<SettingsKeyInfo, SettingsKeyInfoProvider, ObjectQuery<SettingsKeyInfo>>
          CMS.DataEngine.AbstractInfoProvider<SettingsKeyInfo, SettingsKeyInfoProvider>
            CMS.DataEngine.SettingsKeyInfoProvider

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

Syntax

public class SettingsKeyInfoProvider : AbstractInfoProvider<SettingsKeyInfo, SettingsKeyInfoProvider>

The SettingsKeyInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	SettingsKeyInfoProvider	Constructor

Fields

	Name	Description
Public field Static member	GetURL	Executes when URL is requested from the settings
Protected field	hashtableLock	Table lock for loading hashtables (Inherited from BaseAbstractInfoProvider.)
Protected field	infos	Info tables. (Inherited from BaseAbstractInfoProvider.)

Properties

	Name	Description
Protected property	BoolValues	Cached boolean values.
Protected property	DataSource	Data source for the provider (Inherited from BaseAbstractInfoProvider.)
Public property Static member	DeploymentMode	Gets or sets the value that indicates whether the virtual objects are in deployment mode (reflects CMSDeploymentMode hidden setting).
Public property	HashtableSettings	Hashtable settings (Inherited from BaseAbstractInfoProvider.)
Protected property	InfoObject	Info object instance the provider is working with. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	InfoType	Returns the type of the info object for this provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected property	IntValues	Cached integer values.
Public property	IsDataAvailable	Returns true if the data is available for this provider (Inherited from BaseAbstractInfoProvider.)
Public property	IsValid	Indicates if the provider instance is up-to-date and can be used to manage object instances. (Inherited from AbstractProvider.)
Protected property	ProviderName	Provider name (Inherited from BaseAbstractInfoProvider.)
Public property	StoreEmptyValuesInHashtables	If true, provider hashtables store empty values for not found objects to reduce database calls (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	TypeInfo	Object type information. (Inherited from BaseAbstractInfoProvider.)
Public property Static member	VirtualObjectsAllowed	Gets the value that indicates whether virtual path provider is running or deployment mode is set

Methods

	Name	Description
Public method	AddSiteWhereCondition(String, Int32, String, Boolean)	Creates site where condition from the specified parameters and adds it to the original where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	AddSiteWhereCondition(String, Int32, String, Boolean, String)	Creates site where condition from the specified parameters and adds it to the original where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ApplySource<TQuery>	If the provider has a data source specified, applies this source to the given query. Returns the modified query. (Inherited from BaseAbstractInfoProvider.)
Protected method	BoundGetInfoByGuid(Guid)	Gets the info object by its GUID (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	BoundGetInfoByGuid(Guid, Int32)	Gets the info object by its GUID and site ID (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	BoundGetInfoById	Gets the info by ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	BoundGetInfoByName(String)	Gets the info object by its code name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	BoundGetInfoByName(String, Int32)	Gets the info object by its code name and site Id (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	BoundGetInfosByIds	Gets the list of info objects by their IDs (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<TInfo>)	Bulk inserts the given list of info objects (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	ClearCachedValues	Clears all the cached settings key values.
Protected method	ClearCachedValuesInternal	Clears all the cached settings key values.
Protected method	ClearHashtables	Clear hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CreateHashtables	Creates the provider hashtables (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CreateInfo(Int32)	Creates an instance of info object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CreateInfo(DataRow, Boolean)	Creates a new info object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String)	Creates web farm task specific for current object and action name (Inherited from AbstractProvider.)
Public method	CreateWebFarmTask(String, String, Byte[], String)	Creates web farm task specific for current object and action name (Inherited from AbstractProvider.)
Protected method	DeleteData(Action<TQuery>)	Deletes the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	DeleteData(String)	Deletes the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	DeleteData(IWhereCondition)	Deletes the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	DeleteInfo	Deletes the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	DeleteObjectFromHashtables	Deletes the object instance from the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	DeleteSettingsKeyInfo	Deletes the specified settings key.
Protected method	DeleteSettingsKeyInfoInternal	Deletes the specified settings key.
Public method	GetBindingWhereCondition(String, Int32)	Gets the where condition to limit the objects to specific binding dependency. Use this method only for 2-keys bindings. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	GetBindingWhereCondition(String, Object[])	Gets the where condition to limit the objects to specific binding dependencies. Use this method for 3 and more-keys bindings. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetBoolValue(SettingsKeyName)	Returns the boolean value of the specified key from the database or false if not found.
Public method Static member	GetBoolValue(String, SiteInfoIdentifier)	Returns the boolean value of the specified key from the database or false if not found.
Public method Static member	GetBoolValue(String, String, Boolean)	Returns the boolean value of setting in web.config or value of specified key if setting is not present in web.config file.
Protected method	GetBoolValueInternal(String, SiteInfoIdentifier)	Returns the boolean value of the specified key from the database or false if not found.
Protected method	GetBoolValueInternal(String, String, Boolean)	Returns the boolean value of setting in web.config or value of specified key if setting is not present in web.config file.
Protected method	GetCacheDependency(DataSet, String, String)	Gets the cache dependency for the given object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetCacheDependency(BaseInfo, String, String)	Gets the cache dependency for the given object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetCountInternal	Gets the number of items matching the given parameters. Does not check the license when retrieving data. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32)	Returns the data according to the set of input parameters. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32, Int32, Int32, Int32)	Returns the data according to the set of input parameters. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetDataByColumn<T>	Returns the data according to the set of input parameters. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetDataByGuidColumn	Returns the data according to the set of input parameters. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetDataByIntColumn	Returns the data according to the set of input parameters. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetDataByStringColumn	Returns the data according to the set of input parameters. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetDeleteQuery	Gets the object query that deletes all items matching the query parameters (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetDependencyCacheKeys(DataSet, String, String)	Gets the cache dependency keys for the given DataSet. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetDependencyCacheKeys(GeneralizedInfo, String, String)	Gets the cache dependency keys for the given object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetDoubleValue(SettingsKeyName)	Returns the double value of the specified key from the database or 0 if not found.
Public method Static member	GetDoubleValue(String, SiteInfoIdentifier)	Returns the double value of the specified key from the database or 0 if not found.
Protected method	GetDoubleValueInternal	Returns the double value of the specified key from the database or 0 if not found.
Protected method	GetEmptyDataSet	Gets the empty data set to be filled by the data (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetExistingIDsInternal	Filters out all object IDs that do not exist in the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetFilesUrlExtension	Returns URL extension used for files friendly URLs for specified site.
Protected method	GetFullNameDictionary	Creates new dictionary for caching the objects by full name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetFullNameWhereCondition	Gets the where condition that searches the object based on the given full name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfo(Action<TQuery>)	Gets an instance of the first info object matching the specified condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfo(IWhereCondition)	Gets an instance of the first info object matching the specified condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfo(String, String)	Gets an instance of the first info object matching the specified condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Int32)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeNameFromDB	Gets an instance of info object based on the given code name from database (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByFullName(String)	Gets an instance of info object based on the given full name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByFullName(String, Boolean)	Gets an instance of info object based on the given full name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByFullNameInternal	Gets the info by its full name from the database (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid)	Gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Int32)	Gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Int32, Boolean)	Gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuidColumn	Gets an instance of info object based on the string column value. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuidFromDB	Gets an instance of info object based on the given GUID from database (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoById(Int32)	Gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoById(Int32, Boolean)	Gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByIntColumn	Gets an instance of info object based on the integer column value. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByStringColumn	Gets an instance of info object based on the string column value. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfosByIds	Gets the list of info objects by their IDs (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetIntValue(SettingsKeyName)	Returns the integer value of the specified key from the database or 0 if not found.
Public method Static member	GetIntValue(String, SiteInfoIdentifier)	Returns the integer value of the specified key from the database or 0 if not found.
Public method Static member	GetIntValue(String, String, Int32, SiteInfoIdentifier)	Returns the integer value of setting in web.config or value of specified key if setting is not present in web.config file.
Protected method	GetIntValueInternal(String, SiteInfoIdentifier, Int32)	Returns the integer value of the specified key from the database or 0 if not found.
Protected method	GetIntValueInternal(String, String, Int32, SiteInfoIdentifier)	Returns the integer value of setting in web.config or value of specified key if setting is not present in web.config file.
Protected method	GetObjectQuery	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetObjectQueryInternal	Gets the object query for the provider (Overrides AbstractInfoProvider<TInfo, TProvider>.GetObjectQueryInternal().)
Public method	GetParentWhereCondition	Gets the where condition to limit the objects to specific parent. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetSettingsKeyInfo(Int32)	Returns the settings key with specified ID.
Public method Static member	GetSettingsKeyInfo(SettingsKeyName)	Returns the settings key info for key with the specified name. The name can be either KeyName (for global settings) or SiteName.KeyName (for local settings).
Public method Static member	GetSettingsKeyInfo(String, SiteInfoIdentifier)	Returns the settings key info for key with the specified name.
Protected method	GetSettingsKeyInfoInternal	Returns the settings key info for key with the specified name.
Public method Static member	GetSettingsKeys()	Returns all settings keys.
Public method Static member	GetSettingsKeys(Int32, SiteInfoIdentifier)	Returns a DataSet with all the keys for given site and category sorted by KeyDisplayName. If site is not specified, only the global settings are loaded.
Public method Static member	GetSettingsKeys(String, String, Int32, String)	Returns keys by the given parameters
Protected method	GetSettingsKeysInternal	Returns all settings keys.
Protected method	GetSingleObject	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	GetSiteWhereCondition(Int32)	Gets the where condition to limit the objects to specific site. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	GetSiteWhereCondition(Int32, Boolean)	Gets the where condition to limit the objects to specific site. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetTypeInfo	Gets the type info for this provider (Inherited from BaseAbstractInfoProvider.)
Public method Static member	GetURLValue(SettingsKeyName, String)	Gets the URL value from settings.
Public method Static member	GetURLValue(String, SiteInfoIdentifier, String)	Gets the URL value from settings.
Protected method	GetURLValueInternal	Gets the URL value from settings.
Public method Static member	GetValue(SettingsKeyName)	Returns value of the specified key from the database or "" if not found.
Public method Static member	GetValue(String, SiteInfoIdentifier)	Returns value of the specified key from the database or "" if not found.
Public method Static member	GetValueFromDB(SettingsKeyName)	Gets the settings key value from DB.
Public method Static member	GetValueFromDB(String, SiteInfoIdentifier)	Gets the settings key value from DB.
Protected method	GetValueFromDBInternal	Gets the settings key value from DB.
Protected method	GetValueInternal	Returns value of the specified key from the database.
Public method	CheckUniqueCodeName	Checks if the object has unique code name. Returns true if the object has unique code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CheckUniqueValues	Checks if a record with the same column values already exists in the database. Returns true if the set of values is unique. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	Init()	Initializes the settings key provider.
Protected method	Init(ObjectTypeInfo)	Initializes the provider variables. (Inherited from BaseAbstractInfoProvider.)
Protected method	InitHashtables	Initializes the hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	Invalidate	Sets this provider as invalid (Inherited from AbstractProvider.)
Public method Static member	IsValueInherited(SettingsKeyName)	Checks if the value of the specified settings value is inherited.
Public method Static member	IsValueInherited(String, SiteInfoIdentifier)	Checks if the value of the specified settings value is inherited.
Protected method	IsValueInheritedInternal	Checks if the value of the specified settings value is inherited.
Protected method	LoadAllInfos	Loads all infos to the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadGeneration	Loads the specified generation of the objects. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadInfos	Loads all objects from the database to memory. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadObjectsToHashtables	Loads the objects from a DataSet to the hashtables (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	MoveSettingsKeyDown	Moves specified key down.
Public method Static member	MoveSettingsKeyUp	Moves specified key up.
Public method	NewTransaction	Creates a new transaction over this provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	ProcessWebFarmTask	Runs the processing of specific web farm task for current provider (Inherited from BaseAbstractInfoProvider.)
Protected method	RecalculateData	Recalculates the value in the given column using the coefficient. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	RefreshObjectsCounts	Updates all counts for all sub-objects. (Inherited from BaseAbstractInfoProvider.)
Protected method	Register	Registers current provider in providers collection (Inherited from AbstractProvider.)
Protected method	RegisterObjectInHashtables	Registers the object instance within the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	RemoveOriginalCodeNameFromHashtable	Removes the original object code name from the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ReplaceData	Obsolete. Replaces the data in the given columns. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	ResetToDefault	Resets the provider to default implementation (Inherited from AbstractInfoProvider<TProvider>.)
Public method Static member	SearchSettingsKey	Searches display name and description of the specified key for the specified text. The display name and description are localized and HTML encoded prior to searching.
Protected method	SearchSettingsKeyInternal	Searches display name and description of the specified key for the specified text. The display name and description are localized and HTML encoded prior to searching.
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider (Inherited from AbstractInfoProvider<TProvider>.)
Public method Static member	SetGlobalValue	Sets the value of the global key if the key exists.
Protected method	SetInfo	Inserts or Updates the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	SetSettingsKeyInfo	Sets the specified settings key data.
Protected method	SetSettingsKeyInfoInternal	Sets the specified settings key data.
Public method Static member	SetValue	Sets the value of the given key if the key exists.
Protected method	SetValueInternal	Sets the value of the given key if the key exists.
Public method	SortAlphabetically	Sorts the object alphabetically. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	TouchCacheDependencies	Touches the cache dependencies of the given object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateData(String, QueryDataParameters, String)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateData(IWhereCondition, IEnumerable<KeyValuePair<String, Object>>, Boolean)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateObjectInHashtables	Updates the object instance in the hashtables. Updates is different than register, because it logs task about changing object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	UseSource(TInfo[])	Sets the provider to use given data as data source (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	UseSource(DataQuerySource)	Sets the provider to use given data as data source (Inherited from BaseAbstractInfoProvider.)
Public method	ValidateCodeName	Validates the object code name. Returns true if the code name is valid. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)

Events

	Name	Description
Public event Static member	OnSettingsKeyChanged	Occurs when the settings key is changed.