SettingsKeyInfoProvider Class

Provides access to settings keys.

Inheritance Hierarchy

System.Object
  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: 13.0.131

Syntax

public class SettingsKeyInfoProvider : AbstractInfoProvider<SettingsKeyInfo, SettingsKeyInfoProvider>, 
	INotManagedByContainer

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	infos	Info tables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)

Properties

	Name	Description
Public property	DataSource	Data source for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
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	Gets hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected property	InfoObject	Info object instance the provider is working with. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	IsValid	Indicates if the provider instance is up-to-date and can be used to manage object instances. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	TypeInfo	Object type information. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property Static member	VirtualObjectsAllowed	Gets the value that indicates whether virtual path provider is running or deployment mode is set

Methods

	Name	Description
Protected method	BeginTransaction	Creates a new transaction over this provider. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkDelete	Bulk deletes info objects based on the given condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<BaseInfo>)	Bulk inserts the given list of info objects (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<TInfo>, BulkInsertSettings)	Bulk inserts the given list of info objects. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
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>.)
Protected method	ClearHashtables	Clears the object's hashtables. (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.ClearHashtables(Boolean).)
Protected method	CreateDefaultBulkInsertSettings	Creates bulk insert settings. By default CheckConstraints and TableLock flags are set. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CreateInfo	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 AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String,Byte[], String)	Creates web farm task specific for current object and action name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Delete	Deletes the info object from the underlying data store. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	DeleteInfo	Deletes the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	DeleteObjectFromHashtables	Clears the cached value of the specified settings key. (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.DeleteObjectFromHashtables(TInfo).)
Public method Static member	DeleteSettingsKeyInfo	Deletes the specified settings key.
Protected method	DeleteSettingsKeyInfoInternal	Deletes the specified settings key.
Public method	Get()	Gets the object query for TInfo retrieval. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Guid)	Gets an instance of info object based on its GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Int32)	Gets an instance of info object based on its ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(String)	Gets an instance of info object based on its code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Guid, Int32)	Gets an instance of info object based on its GUID and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(String, Int32)	Gets an instance of info object based on its code name and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Guid, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(String, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Guid, Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its GUID and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(String, Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its code name and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
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.
Public method Static member	GetDecimalValue(SettingsKeyName)	Returns the decimal value of the specified key from the database or 0 if not found.
Public method Static member	GetDecimalValue(String, SiteInfoIdentifier)	Returns the decimal value of the specified key from the database or 0 if not found.
Protected method	GetDecimalValueInternal	Returns the decimal value of the specified key from the database or 0 if not found.
Protected method	GetDeleteQuery	Gets the object query that deletes all items matching the query parameters (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	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, Boolean)	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	GetInfoByCodeNameAsync(String, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeNameAsync(String, Int32, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByFullName	Gets an instance of info object based on the given full name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Boolean)	Gets an instance of info object based on the given 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	GetInfoByGuidAsync(Guid, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuidAsync(Guid, Int32, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoById	Gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByIdAsync	Asynchronously gets an instance of info object based on ID. (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 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.
Protected method	GetSettingsKeysInternal	Returns all settings keys.
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. Falls back to the GetValue(SettingsKeyName) if site-specific key is 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.
Protected method	Init	Initializes the provider with the given type info and hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	InitHashtableSettings	Initializes the HashtableSettings based on typeInfo and using settings as default values. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	InitTypeInfoAndRegister	Initializes the provider variables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Invalidate	Sets this provider as invalid (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
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	LoadInfos	Loads all objects from the database to memory. (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	ProcessWebFarmTask	Runs the processing of specific web farm task for current provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ProcessWebFarmTaskInternal	Runs the processing of specific web farm task for current provider (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.ProcessWebFarmTaskInternal(String, String,Byte[]).)
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>.)
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	Set	Inserts or updates the info object in the underlying data store. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	SetAsDefaultProvider	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 AbstractInfoProvider<TInfo, TProvider, TQuery>.)
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.
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 cached value of the specified settings key. (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.UpdateObjectInHashtables(TInfo).)
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.

Remarks

This provider is not managed by the IoC container.