Table of Contents

Class SettingsCategoryInfoProvider

Namespace
CMS.DataEngine
Assembly
CMS.DataEngine.dll

Class providing Settings category management.

[ProviderInterface(typeof(ISettingsCategoryInfoProvider))]
public class SettingsCategoryInfoProvider : AbstractInfoProvider<SettingsCategoryInfo, SettingsCategoryInfoProvider>, IInfoProvider, ICustomizableProvider, IBulkOperationProvider, IWebFarmProvider, IInfoValidator<SettingsCategoryInfo>, IInfoByGuidProvider<SettingsCategoryInfo>, IBulkInfoProvider<SettingsCategoryInfo>, IRelatedObjectCountProvider, ISettingsCategoryInfoProvider, IInfoProvider<SettingsCategoryInfo>, IInfoByIdProvider<SettingsCategoryInfo>, IInfoByNameProvider<SettingsCategoryInfo>
Inheritance
object
SettingsCategoryInfoProvider
Implements
Inherited Members
Extension Methods

Constructors

SettingsCategoryInfoProvider()

Constructor

public SettingsCategoryInfoProvider()

Fields

mRootCategory

Info object representing Settings root category.

public static SettingsCategoryInfo mRootCategory

Field Value

SettingsCategoryInfo

Properties

RootCategory

Returns root settings category (this property is cached).

[Obsolete("Property was not intended for public use and will be removed.")]
[ObsoleteSince(30, 1)]
public static SettingsCategoryInfo RootCategory { get; }

Property Value

SettingsCategoryInfo

Methods

DeleteInfo(SettingsCategoryInfo)

Deletes the object to the database.

protected override void DeleteInfo(SettingsCategoryInfo info)

Parameters

info SettingsCategoryInfo

Object to delete

GetCategoriesOnPath(string)

Gets all the categories on the specified category ID path in the corresponding order.

[Obsolete("Method was not intended for public use and will be removed.")]
[ObsoleteSince(30, 1)]
public static InfoDataSet<SettingsCategoryInfo> GetCategoriesOnPath(string categoryIdPath)

Parameters

categoryIdPath string

Category ID path

Returns

InfoDataSet<SettingsCategoryInfo>

GetCategoriesOnPathWhereCondition(string)

Gets where condition for all parent categories on path except root category.

[Obsolete("Method was not intended for public use and will be removed.")]
[ObsoleteSince(30, 1)]
public static string GetCategoriesOnPathWhereCondition(string categoryIdPath)

Parameters

categoryIdPath string

Category ID path

Returns

string

GetChildSettingsCategories(int)

Gets DataSet with child setting categories of the specified parent setting category.

[Obsolete("Method was not intended for public use and will be removed.")]
[ObsoleteSince(30, 1)]
public static InfoDataSet<SettingsCategoryInfo> GetChildSettingsCategories(int parentCategoryId)

Parameters

parentCategoryId int

ID of the parent setting category

Returns

InfoDataSet<SettingsCategoryInfo>

GetChildSettingsCategories(string, string)

Gets DataSet with child setting categories of the specified parent setting category, filtered by where condition.

[Obsolete("Method was not intended for public use and will be removed.")]
[ObsoleteSince(30, 1)]
public static InfoDataSet<SettingsCategoryInfo> GetChildSettingsCategories(string parentCategoryName, string where)

Parameters

parentCategoryName string

Name of the parent setting category

where string

Where condition

Returns

InfoDataSet<SettingsCategoryInfo>

GetChildSettingsCategoriesInternal(int)

Gets DataSet with child setting categories of the specified parent category.

[Obsolete("Method was not intended for public use and will be removed.")]
[ObsoleteSince(30, 1)]
protected virtual InfoDataSet<SettingsCategoryInfo> GetChildSettingsCategoriesInternal(int parentCategoryId)

Parameters

parentCategoryId int

ID of the parent setting category

Returns

InfoDataSet<SettingsCategoryInfo>

GetChildSettingsCategoriesInternal(string, string)

Gets DataSet with child setting categories of the specified parent category.

[Obsolete("Method was not intended for public use and will be removed.")]
[ObsoleteSince(30, 1)]
protected virtual InfoDataSet<SettingsCategoryInfo> GetChildSettingsCategoriesInternal(string parentCategoryName, string where)

Parameters

parentCategoryName string

Code name of the parent setting category

where string

Where condition

Returns

InfoDataSet<SettingsCategoryInfo>

GetLastSettingsCategoryOrder(int)

Returns last SettingsCategory order for specified parent SettingsCategory.

[Obsolete("Method was not intended for public use and will be removed.")]
[ObsoleteSince(30, 1)]
public static int GetLastSettingsCategoryOrder(int parentCategoryID)

Parameters

parentCategoryID int

Parent SettingsCategory ID

Returns

int

GetLastSettingsCategoryOrderInternal(int)

Returns last order for specified parent SettingsCategory.

[Obsolete("Method was not intended for public use and will be removed.")]
[ObsoleteSince(30, 1)]
protected virtual int GetLastSettingsCategoryOrderInternal(int parentCategoryID)

Parameters

parentCategoryID int

Parent SettingsCategory ID

Returns

int

GetRootSettingsCategoryInfo()

Gets root of categories. This is distinguished by CategoryLevel = 0. If more found -> use first.

[Obsolete("Method was not intended for public use and will be removed.")]
[ObsoleteSince(30, 1)]
public static SettingsCategoryInfo GetRootSettingsCategoryInfo()

Returns

SettingsCategoryInfo

GetSettingsCategories(string, string, int, string)

Gets all categories.

[Obsolete("Method was not intended for public use and will be removed.")]
[ObsoleteSince(30, 1)]
public static InfoDataSet<SettingsCategoryInfo> GetSettingsCategories(string where, string orderBy = null, int topN = -1, string columns = null)

Parameters

where string

Where condition to filter data

orderBy string

Order by statement to use

topN int

Number of data rows which should be included in the result

columns string

Table columns separated by comma which should be included in the result

Returns

InfoDataSet<SettingsCategoryInfo>

GetSettingsCategoriesInternal(string, string, int, string)

Gets all categories.

[Obsolete("Method was not intended for public use and will be removed.")]
[ObsoleteSince(30, 1)]
protected virtual InfoDataSet<SettingsCategoryInfo> GetSettingsCategoriesInternal(string where, string orderBy, int topN, string columns)

Parameters

where string

Where condition to filter data

orderBy string

Order by statement to use

topN int

Number of data rows which should be included in the result

columns string

Table columns which should be included in the result

Returns

InfoDataSet<SettingsCategoryInfo>

MoveCategoryDown(int)

Moves specified category down.

[Obsolete("Method was not intended for public use and will be removed.")]
[ObsoleteSince(30, 1)]
public static void MoveCategoryDown(int categoryId)

Parameters

categoryId int

Category ID

MoveCategoryDownInternal(int)

Moves specified category down.

[Obsolete("Method was not intended for public use and will be removed.")]
[ObsoleteSince(30, 1)]
protected virtual void MoveCategoryDownInternal(int categoryId)

Parameters

categoryId int

Category ID

MoveCategoryUp(int)

Moves specified category up.

[Obsolete("Method was not intended for public use and will be removed.")]
[ObsoleteSince(30, 1)]
public static void MoveCategoryUp(int categoryId)

Parameters

categoryId int

Category ID

MoveCategoryUpInternal(int)

Moves specified category up.

[Obsolete("Method was not intended for public use and will be removed.")]
[ObsoleteSince(30, 1)]
protected virtual void MoveCategoryUpInternal(int categoryId)

Parameters

categoryId int

Category ID

RefreshDataCounts()

Updates all counts for all sub-objects.

[Obsolete("Method was not intended for public use and will be removed.")]
[ObsoleteSince(30, 1)]
public static void RefreshDataCounts()

RefreshDataCountsInternal()

Updates all counts for all sub-objects.

[Obsolete("Method was not intended for public use and will be removed.")]
[ObsoleteSince(30, 1)]
protected virtual void RefreshDataCountsInternal()

RefreshObjectsCounts()

Updates all counts for all sub-objects.

[Obsolete("Method was not intended for public use and will be removed.")]
[ObsoleteSince(30, 1)]
public void RefreshObjectsCounts()

SetInfo(SettingsCategoryInfo)

Inserts or Updates the object to the database.

protected override void SetInfo(SettingsCategoryInfo info)

Parameters

info SettingsCategoryInfo

Object to insert / update

SetSettingsCategoryChildCount(int)

Sets correct SettingsCategoryChildCount to the specified SettingsCategory.

[Obsolete("Method was not intended for public use and will be removed.")]
[ObsoleteSince(30, 1)]
public static void SetSettingsCategoryChildCount(int settingsCategoryID)

Parameters

settingsCategoryID int

ID of the SettingsCategory

SetSettingsCategoryChildCountInternal(int)

Sets correct CategoryChildCount to the specified SettingsCategory.

[Obsolete("Method was not intended for public use and will be removed.")]
[ObsoleteSince(30, 1)]
protected virtual void SetSettingsCategoryChildCountInternal(int settingsCategoryID)

Parameters

settingsCategoryID int

ID of the SettingsCategory