Table of Contents

Class SettingsKeyInfo

Namespace
CMS.DataEngine
Assembly
CMS.DataEngine.dll

Represents a Settings key.

[InfoCache(InfoCacheBy.Name, LoadEagerly = true, Priority = InfoCachePriority.NotRemovable)]
public class SettingsKeyInfo : AbstractInfo<SettingsKeyInfo, ISettingsKeyInfoProvider>, IExtensible, IInfo, IAdvancedDataContainer, ICMSObject, IHierarchicalDataContainer, IDataContainer, ISimpleDataContainer, IVirtualHierarchicalObject, IHierarchicalObject, INameIndexable, IMacroObject, IInfoWithId, IInfoWithGuid, IInfoWithName
Inheritance
object
SettingsKeyInfo
Implements
Inherited Members
Extension Methods

Constructors

SettingsKeyInfo()

Constructor, creates an empty SettingsKeyInfo structure.

public SettingsKeyInfo()

SettingsKeyInfo(DataRow)

Constructor, creates the DataClassInfo object from the given DataRow data.

public SettingsKeyInfo(DataRow dr)

Parameters

dr DataRow

Datarow with the class info data

Fields

OBJECT_TYPE

Object type

public const string OBJECT_TYPE = "cms.settingskey"

Field Value

string

TYPEINFO

Type information.

public static ObjectTypeInfo TYPEINFO

Field Value

ObjectTypeInfo

Properties

KeyCategoryID

Gets or sets the key category ID.

[DatabaseField]
public virtual int KeyCategoryID { get; set; }

Property Value

int

KeyDescription

Gets or sets the key description.

[DatabaseField]
public virtual string KeyDescription { get; set; }

Property Value

string

KeyDisplayName

Gets or sets the key display name.

[DatabaseField]
public virtual string KeyDisplayName { get; set; }

Property Value

string

KeyEditingControlPath

Gets or sets the path to formcontrol which can be used to edit the settings.

[DatabaseField]
public virtual string KeyEditingControlPath { get; set; }

Property Value

string

KeyExplanationText

Gets or sets the key explanation text.

[DatabaseField]
public virtual string KeyExplanationText { get; set; }

Property Value

string

KeyFormControlSettings

Gets or sets the form control settings serialized in XML.

[DatabaseField]
public virtual string KeyFormControlSettings { get; set; }

Property Value

string

KeyGUID

Key GUID.

[DatabaseField]
public virtual Guid KeyGUID { get; set; }

Property Value

Guid

KeyID

Gets or sets the key ID.

[DatabaseField]
public virtual int KeyID { get; set; }

Property Value

int

KeyIsCustom

Indicates whether the settings key is custom or system default.

[DatabaseField]
public bool KeyIsCustom { get; set; }

Property Value

bool

KeyIsHidden

Indicates whether the settings key is hidden or not. If it is set to true, such key will not be displayed in the settings section and users will not be able to edit value of such key.

[DatabaseField]
public bool KeyIsHidden { get; set; }

Property Value

bool

KeyLastModified

Time stamp.

[DatabaseField]
public virtual DateTime KeyLastModified { get; set; }

Property Value

DateTime

KeyName

Gets or sets the key name.

[DatabaseField]
public virtual string KeyName { get; set; }

Property Value

string

KeyOrder

Gets or sets the key order.

[DatabaseField]
public virtual int KeyOrder { get; set; }

Property Value

int

KeyType

Gets or sets the key type.

[DatabaseField]
public virtual string KeyType { get; set; }

Property Value

string

KeyValidation

Gets or sets regular expression for validation.

[DatabaseField]
public virtual string KeyValidation { get; set; }

Property Value

string

KeyValue

Gets or sets the key value.

[DatabaseField]
public virtual string KeyValue { get; set; }

Property Value

string

Methods

DeleteObject()

Deletes the object using appropriate provider.

protected override void DeleteObject()

GetDefaultData(IEnumerable<string>)

Returns the default object installation data

protected override DataSet GetDefaultData(IEnumerable<string> excludedNames = null)

Parameters

excludedNames IEnumerable<string>

Objects with display names and code names starting with these expressions are filtered out.

Returns

DataSet

GetSiblingsWhereCondition()

Creates where condition according to Parent settings.

protected override WhereCondition GetSiblingsWhereCondition()

Returns

WhereCondition

SetObject()

Updates the object using appropriate provider.

protected override void SetObject()

Validate()

Uses the SettingsKeyInfoProvider's validation method to validate this info object.

protected override InfoValidationResult Validate()

Returns

InfoValidationResult