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

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

The SettingsKeyInfoProvider type exposes the following members.

Constructors
  NameDescription
Public methodSettingsKeyInfoProvider
Constructor
Top
Fields
Properties
  NameDescription
Public propertyDataSource
Data source for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyStatic memberDeploymentMode
Gets or sets the value that indicates whether the virtual objects are in deployment mode (reflects CMSDeploymentMode hidden setting).
Public propertyHashtableSettings
Gets hashtable settings
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected propertyInfoObject
Info object instance the provider is working with.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyIsValid
Indicates if the provider instance is up-to-date and can be used to manage object instances.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyTypeInfo
Object type information.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyStatic memberVirtualObjectsAllowed
Gets the value that indicates whether virtual path provider is running or deployment mode is set
Top
Methods
  NameDescription
Protected methodBeginTransaction
Creates a new transaction over this provider.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkDelete
Bulk deletes info objects based on the given condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkInsertInfos(IEnumerableBaseInfo)
Bulk inserts the given list of info objects
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkInsertInfos(IEnumerableTInfo, BulkInsertSettings)
Bulk inserts the given list of info objects.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
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.)
Protected methodClearHashtables
Clears the object's hashtables.
(Overrides AbstractInfoProviderTInfo, TProvider, TQueryClearHashtables(Boolean).)
Protected methodCreateDefaultBulkInsertSettings
Creates bulk insert settings. By default CheckConstraints and TableLock flags are set.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodCreateInfo
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 AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCreateWebFarmTask(String, String, Byte, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodDelete
Deletes the info object from the underlying data store.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodDeleteInfo
Deletes the object to the database.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodDeleteObjectFromHashtables
Clears the cached value of the specified settings key.
(Overrides AbstractInfoProviderTInfo, TProvider, TQueryDeleteObjectFromHashtables(TInfo).)
Public methodStatic memberDeleteSettingsKeyInfo
Deletes the specified settings key.
Protected methodDeleteSettingsKeyInfoInternal
Deletes the specified settings key.
Public methodGet
Gets the object query for TInfo retrieval.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(Guid)
Gets an instance of info object based on its GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(Int32)
Gets an instance of info object based on its ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(String)
Gets an instance of info object based on its code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(Guid, Int32)
Gets an instance of info object based on its GUID and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(String, Int32)
Gets an instance of info object based on its code name and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(Guid, NullableCancellationToken)
Asynchronously gets an instance of info object based on its GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(Int32, NullableCancellationToken)
Asynchronously gets an instance of info object based on its ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(String, NullableCancellationToken)
Asynchronously gets an instance of info object based on its code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(Guid, Int32, NullableCancellationToken)
Asynchronously gets an instance of info object based on its GUID and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(String, Int32, NullableCancellationToken)
Asynchronously gets an instance of info object based on its code name and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
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.
Public methodStatic memberGetDecimalValue(SettingsKeyName)
Returns the decimal value of the specified key from the database or 0 if not found.
Public methodStatic memberGetDecimalValue(String, SiteInfoIdentifier)
Returns the decimal value of the specified key from the database or 0 if not found.
Protected methodGetDecimalValueInternal
Returns the decimal value of the specified key from the database or 0 if not found.
Protected methodGetDeleteQuery
Gets the object query that deletes all items matching the query parameters
(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 methodGetInfoByCodeName(String, Boolean)
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, 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 methodGetInfoByCodeNameAsync(String, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeNameAsync(String, Int32, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByFullName
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuid(Guid, Boolean)
Gets an instance of info object based on the given 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 methodGetInfoByGuidAsync(Guid, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuidAsync(Guid, Int32, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoById
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByIdAsync
Asynchronously gets an instance of info object based on ID.
(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 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.
Protected methodGetSettingsKeysInternal
Returns all settings keys.
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. Falls back to the GetValue(SettingsKeyName) if site-specific key is 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.
Protected methodInit
Initializes the provider with the given type info and hashtable settings
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodInitHashtableSettings
Initializes the HashtableSettings based on typeInfo and using settings as default values.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodInitTypeInfoAndRegister
Initializes the provider variables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodInvalidate
Sets this provider as invalid
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
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 methodLoadInfos
Loads all objects from the database to memory.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberMoveSettingsKeyDown
Moves specified key down.
Public methodStatic memberMoveSettingsKeyUp
Moves specified key up.
Public methodProcessWebFarmTask
Runs the processing of specific web farm task for current provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodProcessWebFarmTaskInternal
Runs the processing of specific web farm task for current provider
(Overrides AbstractInfoProviderTInfo, TProvider, TQueryProcessWebFarmTaskInternal(String, String, Byte).)
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.)
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 methodSet
Inserts or updates the info object in the underlying data store.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodSetAsDefaultProvider

Sets this provider instance as the default provider.

Since the providers are managed by IoC container, setting the provider instance must be performed before the IoC container initialization finishes (i.e. during application pre-initialization).

(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
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.
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 cached value of the specified settings key.
(Overrides AbstractInfoProviderTInfo, TProvider, TQueryUpdateObjectInHashtables(TInfo).)
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
Remarks
This provider is not managed by the IoC container.
See Also