StringAppSetting Class

Defined lazy initialized string setting

Inheritance Hierarchy

System.Object
  CMS.Base.CMSLazy<String>
    CMS.Base.AppSetting<String>
      CMS.Base.StringAppSetting

Namespace: CMS.Base
Assembly: CMS.Base (in CMS.Base.dll) Version: 11.0.0

Syntax

public class StringAppSetting : AppSetting<string>

The StringAppSetting type exposes the following members.

Constructors

	Name	Description
Public method	StringAppSetting	Constructor

Properties

	Name	Description
Public property	AllowCloneForNewThread	If true, the item is copied for the new thread (Inherited from CMSLazy<TValue>.)
Protected property	Converter	Conversion function (Inherited from AppSetting<TValue>.)
Public property	DefaultValue	Default value (Inherited from CMSLazy<TValue>.)
Public property	DefaultValueInitializer	Function to retrieve the default value (Inherited from AppSetting<TValue>.)
Protected property	Initializer	Value initialization function (Inherited from CMSLazy<TValue>.)
Public property	IsValueCreated	Returns true if the value was already created (Inherited from CMSLazy<TValue>.)
Public property	KeyName	Settings key name (Inherited from AppSetting<TValue>.)
Public property	MasterKeyName	Defines the master key name which is used in case the key name value is not found (Inherited from AppSetting<TValue>.)
Public property	RequestStockKey	Defines the key under which the object value should be stored in the request stock helper. If set, the object exists only within the particular request (Inherited from CMSLazy<TValue>.)
Public property	Value	Gets or sets the object value (Inherited from CMSLazy<TValue>.)

Methods

	Name	Description
Protected method	CanInitialize	Returns true, if the object value can initialize (Inherited from CMSLazy<TValue>.)
Protected method	ConvertValue	Converts the value to a proper type (Overrides AppSetting<TValue>.ConvertValue(Object, TValue).)
Protected method	NewValue	Initializes a new value (Inherited from AppSetting<TValue>.)
Public method	Reset	Resets the state of the object to re-initialize the value on the next request (Inherited from CMSLazy<TValue>.)
Public method	ToString	Returns value converted to string. (Inherited from AppSetting<TValue>.)