Click or drag to resize
SettingsKeyInfoProvider Class
Provides access to settings keys.
Inheritance Hierarchy
SystemObject
  CMS.DataEngineAbstractProvider
    CMS.DataEngineBaseAbstractInfoProvider
      CMS.DataEngineAbstractInfoProviderSettingsKeyInfoProvider
        CMS.DataEngineAbstractInfoProviderSettingsKeyInfo, SettingsKeyInfoProvider, ObjectQuerySettingsKeyInfo
          CMS.DataEngineAbstractInfoProviderSettingsKeyInfo, SettingsKeyInfoProvider
            CMS.DataEngineSettingsKeyInfoProvider

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 9.0.0
Syntax
C#
public class SettingsKeyInfoProvider : AbstractInfoProvider<SettingsKeyInfo, SettingsKeyInfoProvider>

The SettingsKeyInfoProvider type exposes the following members.

Constructors
  NameDescription
Public methodSettingsKeyInfoProvider
Constructor
Top
Fields
  NameDescription
Public fieldStatic memberGetURL
Executes when URL is requested from the settings
Protected fieldhashtableLock
Table lock for loading hashtables
(Inherited from BaseAbstractInfoProvider.)
Protected fieldinfos
Info tables.
(Inherited from BaseAbstractInfoProvider.)
Top
Properties
  NameDescription
Protected propertyBoolValues
Cached boolean values.
Protected propertyDataSource
Data source for the provider
(Inherited from BaseAbstractInfoProvider.)
Public propertyStatic memberDeploymentMode
Gets or sets the value that indicates whether the virtual objects are in deployment mode (reflects CMSDeploymentMode hidden setting).
Public propertyHashtableSettings
Hashtable settings
(Inherited from BaseAbstractInfoProvider.)
Protected propertyInfoObject
Info object instance the provider is working with.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyInfoType
Returns the type of the info object for this provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected propertyIntValues
Cached integer values.
Public propertyIsDataAvailable
Returns true if the data is available for this provider
(Inherited from BaseAbstractInfoProvider.)
Public propertyIsValid
Indicates if the provider instance is up-to-date and can be used to manage object instances.
(Inherited from AbstractProvider.)
Protected propertyProviderName
Provider name
(Inherited from BaseAbstractInfoProvider.)
Public propertyStoreEmptyValuesInHashtables
If true, provider hashtables store empty values for not found objects to reduce database calls
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyTypeInfo
Object type information.
(Inherited from BaseAbstractInfoProvider.)
Public propertyStatic memberVirtualObjectsAllowed
Gets the value that indicates whether virtual path provider is running or deployment mode is set
Top
Methods
  NameDescription
Public methodAddSiteWhereCondition(String, Int32, String, Boolean)
Creates site where condition from the specified parameters and adds it to the original where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodAddSiteWhereCondition(String, Int32, String, Boolean, String)
Creates site where condition from the specified parameters and adds it to the original where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodApplySourceTQuery
If the provider has a data source specified, applies this source to the given query. Returns the modified query.
(Inherited from BaseAbstractInfoProvider.)
Protected methodBoundGetInfoByGuid(Guid)
Gets the info object by its GUID
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodBoundGetInfoByGuid(Guid, Int32)
Gets the info object by its GUID and site ID
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodBoundGetInfoById
Gets the info by ID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodBoundGetInfoByName(String)
Gets the info object by its code name
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodBoundGetInfoByName(String, Int32)
Gets the info object by its code name and site Id
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodBoundGetInfosByIds
Gets the list of info objects by their IDs
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkInsertInfos(IEnumerableTInfo)
Bulk inserts the given list of info objects
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberClearCachedValues
Clears all the cached settings key values.
Protected methodClearCachedValuesInternal
Clears all the cached settings key values.
Protected methodClearHashtables
Clear hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodCreateHashtables
Creates the provider hashtables
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodCreateInfo(Int32)
Creates an instance of info object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodCreateInfo(DataRow, Boolean)
Creates a new info object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCreateWebFarmTask(String, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractProvider.)
Public methodCreateWebFarmTask(String, String, Byte, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractProvider.)
Protected methodDeleteData(ActionTQuery)
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodDeleteData(String)
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodDeleteData(IWhereCondition)
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodDeleteInfo
Deletes the object to the database.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodDeleteObjectFromHashtables
Deletes the object instance from the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberDeleteSettingsKeyInfo
Deletes the specified settings key.
Protected methodDeleteSettingsKeyInfoInternal
Deletes the specified settings key.
Public methodGetBindingWhereCondition(String, Int32)
Gets the where condition to limit the objects to specific binding dependency. Use this method only for 2-keys bindings.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodGetBindingWhereCondition(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 AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetBoolValue(SettingsKeyName)
Returns the boolean value of the specified key from the database or false if not found.
Public methodStatic memberGetBoolValue(String, SiteInfoIdentifier)
Returns the boolean value of the specified key from the database or false if not found.
Public methodStatic memberGetBoolValue(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 methodGetBoolValueInternal(String, SiteInfoIdentifier)
Returns the boolean value of the specified key from the database or false if not found.
Protected methodGetBoolValueInternal(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 methodGetCacheDependency(DataSet, String, String)
Gets the cache dependency for the given object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetCacheDependency(BaseInfo, String, String)
Gets the cache dependency for the given object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetCountInternal
Gets the number of items matching the given parameters. Does not check the license when retrieving data.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32)
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32, Int32, Int32, Int32)
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetDataByColumnT
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetDataByGuidColumn
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetDataByIntColumn
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetDataByStringColumn
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetDeleteQuery
Gets the object query that deletes all items matching the query parameters
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetDependencyCacheKeys(DataSet, String, String)
Gets the cache dependency keys for the given DataSet.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetDependencyCacheKeys(GeneralizedInfo, String, String)
Gets the cache dependency keys for the given object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetDoubleValue(SettingsKeyName)
Returns the double value of the specified key from the database or 0 if not found.
Public methodStatic memberGetDoubleValue(String, SiteInfoIdentifier)
Returns the double value of the specified key from the database or 0 if not found.
Protected methodGetDoubleValueInternal
Returns the double value of the specified key from the database or 0 if not found.
Protected methodGetEmptyDataSet
Gets the empty data set to be filled by the data
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetExistingIDsInternal
Filters out all object IDs that do not exist in the database.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetFilesUrlExtension
Returns URL extension used for files friendly URLs for specified site.
Protected methodGetFullNameDictionary
Creates new dictionary for caching the objects by full name
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetFullNameWhereCondition
Gets the where condition that searches the object based on the given full name
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfo(ActionTQuery)
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfo(IWhereCondition)
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfo(String, String)
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Int32)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Boolean, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeNameFromDB
Gets an instance of info object based on the given code name from database
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByFullName(String)
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByFullName(String, Boolean)
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByFullNameInternal
Gets the info by its full name from the database
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuid(Guid)
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuid(Guid, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuid(Guid, Int32)
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuid(Guid, Int32, Boolean)
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuidColumn
Gets an instance of info object based on the string column value.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuidFromDB
Gets an instance of info object based on the given GUID from database
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoById(Int32)
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoById(Int32, Boolean)
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByIntColumn
Gets an instance of info object based on the integer column value.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByStringColumn
Gets an instance of info object based on the string column value.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfosByIds
Gets the list of info objects by their IDs
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetIntValue(SettingsKeyName)
Returns the integer value of the specified key from the database or 0 if not found.
Public methodStatic memberGetIntValue(String, SiteInfoIdentifier)
Returns the integer value of the specified key from the database or 0 if not found.
Public methodStatic memberGetIntValue(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 methodGetIntValueInternal(String, SiteInfoIdentifier, Int32)
Returns the integer value of the specified key from the database or 0 if not found.
Protected methodGetIntValueInternal(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 methodGetObjectQuery
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetObjectQueryInternal
Gets the object query for the provider
(Overrides AbstractInfoProviderTInfo, TProviderGetObjectQueryInternal.)
Public methodGetParentWhereCondition
Gets the where condition to limit the objects to specific parent.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetSettingsKeyInfo(Int32)
Returns the settings key with specified ID.
Public methodStatic memberGetSettingsKeyInfo(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 methodStatic memberGetSettingsKeyInfo(String, SiteInfoIdentifier)
Returns the settings key info for key with the specified name.
Protected methodGetSettingsKeyInfoInternal
Returns the settings key info for key with the specified name.
Public methodStatic memberGetSettingsKeys
Returns all settings keys.
Public methodStatic memberGetSettingsKeys(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 methodStatic memberGetSettingsKeys(String, String, Int32, String)
Returns keys by the given parameters
Protected methodGetSettingsKeysInternal
Returns all settings keys.
Protected methodGetSingleObject
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodGetSiteWhereCondition(Int32)
Gets the where condition to limit the objects to specific site.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodGetSiteWhereCondition(Int32, Boolean)
Gets the where condition to limit the objects to specific site.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetTypeInfo
Gets the type info for this provider
(Inherited from BaseAbstractInfoProvider.)
Public methodStatic memberGetURLValue(SettingsKeyName, String)
Gets the URL value from settings.
Public methodStatic memberGetURLValue(String, SiteInfoIdentifier, String)
Gets the URL value from settings.
Protected methodGetURLValueInternal
Gets the URL value from settings.
Public methodStatic memberGetValue(SettingsKeyName)
Returns value of the specified key from the database or "" if not found.
Public methodStatic memberGetValue(String, SiteInfoIdentifier)
Returns value of the specified key from the database or "" if not found.
Public methodStatic memberGetValueFromDB(SettingsKeyName)
Gets the settings key value from DB.
Public methodStatic memberGetValueFromDB(String, SiteInfoIdentifier)
Gets the settings key value from DB.
Protected methodGetValueFromDBInternal
Gets the settings key value from DB.
Protected methodGetValueInternal
Returns value of the specified key from the database.
Public methodCheckUniqueCodeName
Checks if the object has unique code name. Returns true if the object has unique code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCheckUniqueValues
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 AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberInit
Initializes the settings key provider.
Protected methodInit(ObjectTypeInfo)
Initializes the provider variables.
(Inherited from BaseAbstractInfoProvider.)
Protected methodInitHashtables
Initializes the hashtable settings
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodInvalidate
Sets this provider as invalid
(Inherited from AbstractProvider.)
Public methodStatic memberIsValueInherited(SettingsKeyName)
Checks if the value of the specified settings value is inherited.
Public methodStatic memberIsValueInherited(String, SiteInfoIdentifier)
Checks if the value of the specified settings value is inherited.
Protected methodIsValueInheritedInternal
Checks if the value of the specified settings value is inherited.
Protected methodLoadAllInfos
Loads all infos to the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodLoadGeneration
Loads the specified generation of the objects.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodLoadInfos
Loads all objects from the database to memory.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodLoadObjectsToHashtables
Loads the objects from a DataSet to the hashtables
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberMoveSettingsKeyDown
Moves specified key down.
Public methodStatic memberMoveSettingsKeyUp
Moves specified key up.
Public methodNewTransaction
Creates a new transaction over this provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodProcessWebFarmTask
Runs the processing of specific web farm task for current provider
(Inherited from BaseAbstractInfoProvider.)
Protected methodRecalculateData
Recalculates the value in the given column using the coefficient.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodRefreshObjectsCounts
Updates all counts for all sub-objects.
(Inherited from BaseAbstractInfoProvider.)
Protected methodRegister
Registers current provider in providers collection
(Inherited from AbstractProvider.)
Protected methodRegisterObjectInHashtables
Registers the object instance within the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodRemoveOriginalCodeNameFromHashtable
Removes the original object code name from the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodReplaceData Obsolete.
Replaces the data in the given columns.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodResetToDefault
Resets the provider to default implementation
(Inherited from AbstractInfoProviderTProvider.)
Public methodStatic memberSearchSettingsKey
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 methodSearchSettingsKeyInternal
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 methodSetAsDefaultProvider
Sets this provider instance as the default provider
(Inherited from AbstractInfoProviderTProvider.)
Public methodStatic memberSetGlobalValue
Sets the value of the global key if the key exists.
Protected methodSetInfo
Inserts or Updates the object to the database.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberSetSettingsKeyInfo
Sets the specified settings key data.
Protected methodSetSettingsKeyInfoInternal
Sets the specified settings key data.
Public methodStatic memberSetValue
Sets the value of the given key if the key exists.
Protected methodSetValueInternal
Sets the value of the given key if the key exists.
Public methodSortAlphabetically
Sorts the object alphabetically.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodTouchCacheDependencies
Touches the cache dependencies of the given object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodUpdateData(String, QueryDataParameters, String)
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodUpdateData(IWhereCondition, IEnumerableKeyValuePairString, Object, Boolean)
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodUpdateObjectInHashtables
Updates the object instance in the hashtables. Updates is different than register, because it logs task about changing object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodUseSource(TInfo)
Sets the provider to use given data as data source
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodUseSource(DataQuerySource)
Sets the provider to use given data as data source
(Inherited from BaseAbstractInfoProvider.)
Public methodValidateCodeName
Validates the object code name. Returns true if the code name is valid.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Top
Events
  NameDescription
Public eventStatic memberOnSettingsKeyChanged
Occurs when the settings key is changed.
Top
See Also