Kentico CMS 7.0 Context Help

Custom settings

Custom settings

Previous topic Next topic Mail us feedback on this topic!  

Custom settings

Previous topic Next topic JavaScript is required for the print function Mail us feedback on this topic!  

On this page, you can see the category menu together with the category tree, and the right part contains the contents of the selected category.

 

From the category menu, you can create a new category using the AddNewCustomSettingsCategory New category link, delete a category using the DeleteCustomSettingsCategory Delete category link and you can also move Up (Up_UIElement) and move Down (Down_UIElement) the categories.

 

On the Settings tab, you can create a new group under the selected category using the AddNewSettingsGroup New settings group link, and you can also Edit (Edit), Delete (Delete), Move up (Up) and Move down (Down) the groups. Under the selected group, keys can be created using the NewSettingsKey New settings key link. The keys can also be Edited (Edit), Deleted (Delete), Moved up (Up) and Moved down (Down).

 

On the General tab, you can modify properties of the selected category and you can also, by changing its parent category, move this category under a different category.

 

Category properties:

 

Display name

The name of the category displayed to website administrators.

Code name

The name of the category used in the code.

Icon path

The icon displayed next to the category caption; you can enter either a full relative path beginning with ~ (e.g. ~/App_Themes/Default/Images/CMSModules/list.png) or a short path beginning under the Images folder of the current skin (e.g. CMSModules/list.png).

Parent category

The category where this custom category belongs; you can select another parent category to move the custom category under a different category.

 

Group properties:

 

Display name

The name of the group displayed to website administrators.

Code name

The name of the group used in the code.

Parent category

The category where this group belongs; you can select another parent category to move the custom group to a different category.

 

Key properties:

 

Display name

The name of the key displayed to website administrators.

Code name

The name of the key used in the code.

Description

Text describing the key and its purpose.

Group

The group under which this key belongs. You can move the key to a different group by selecting it from the list.

Type

The type of the key's value. You can choose the boolean, integer, double or string value type. The value entered in Site Manager -> Settings -> Custom settings will be validated against the Type property.

Default value

The default value of the key. Values of custom keys can be reset to default in Site Manager -> Settings -> Custom settings using the Reset these settings to default link.

Validation regex

If you wish to define custom validation rules for the setting's value, you can do so by entering a regular expression here.

Custom control

Specifies the control that will be used to edit the key's value in the settings form.

 

The Form control option allows you to choose one of the form controls registered in the system. If you select File system path, you can directly specify the path to a user control file in the web project, e.g. ~/CMSFormControls/SimpleCountrySelector.ascx.

Key is only global

If checked, all available sites will share the same value for the custom key. Additionally, the key will only be available when editing (global) settings.

 

Detailed information about Custom settings can be found at Developer's Guide -> Website settings.