Table of Contents

Class SettingsCategoryInfo

Namespace
CMS.DataEngine
Assembly
CMS.DataEngine.dll

Represents a Settings key.

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

Constructors

SettingsCategoryInfo()

Constructor, creates an empty SettingsKeyInfo structure.

public SettingsCategoryInfo()

SettingsCategoryInfo(DataRow)

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

public SettingsCategoryInfo(DataRow dr)

Parameters

dr DataRow

Datarow with the class info data

Fields

OBJECT_TYPE

Object type

public const string OBJECT_TYPE = "cms.settingscategory"

Field Value

string

TYPEINFO

Type information.

public static ObjectTypeInfo TYPEINFO

Field Value

ObjectTypeInfo

Properties

CategoryChildCount

Number of category child categories.

public int CategoryChildCount { get; set; }

Property Value

int

CategoryDisplayName

Category display name.

public string CategoryDisplayName { get; set; }

Property Value

string

CategoryID

Category ID.

public int CategoryID { get; set; }

Property Value

int

CategoryIDPath

Category ID path within the category tree.

public string CategoryIDPath { get; set; }

Property Value

string

CategoryIconPath

Category icon path.

public string CategoryIconPath { get; set; }

Property Value

string

CategoryIsCustom

Indicates if category is custom. True -> It is a custom category, False -> It is a system category.

public bool CategoryIsCustom { get; set; }

Property Value

bool

CategoryIsGroup

Indicates if category represents group. True -> It is a settings group, False -> It is a settings category.

public bool CategoryIsGroup { get; set; }

Property Value

bool

CategoryLevel

Category level in the category tree.

public int CategoryLevel { get; set; }

Property Value

int

CategoryName

Category name.

public string CategoryName { get; set; }

Property Value

string

CategoryOrder

Category order.

public int CategoryOrder { get; set; }

Property Value

int

CategoryParentID

Category parent ID.

public int CategoryParentID { get; set; }

Property Value

int

CategoryResourceID

Category resource identifier.

public int CategoryResourceID { get; set; }

Property Value

int

Methods

BuildObjectPath(string, string, string, string, out int)

Builds the path from the given column.

protected override string BuildObjectPath(string parentColumName, string pathColumnName, string levelColumnName, string pathPartColumn, out int level)

Parameters

parentColumName string

Column of the parent ID

pathColumnName string

Column name to build the path from

levelColumnName string

Column name of the level

pathPartColumn string

Name of the column which creates the path (IDColumn for IDPath, CodeNameColumn for name path)

level int

Level of the object within the tree hierarchy

Returns

string

DeleteObject()

Deletes the object using appropriate provider.

protected override void DeleteObject()

GetSiblingsWhereCondition()

Creates where condition according to Parent, Group and Site settings.

protected override WhereCondition GetSiblingsWhereCondition()

Returns

WhereCondition

SetObject()

Updates the object using appropriate provider.

protected override void SetObject()