Kentico CMS 6.0 Controls

Configuration

Configuration

Previous topic Next topic Mail us feedback on this topic!  

Configuration

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

The following properties of the CMSTreeMenu control can be set or used in the API:

 

All of the common properties from:

 

CMS controls - common properties

CMS navigation - common properties

 

In addition, the following properties are available:

 

Property Name

Description

Sample Value

CellPadding

Cell padding of the table representing the menu.

 

CellSpacing

Cell spacing of the table representing the menu.


CollapseSelectedNodeOnClick

Indicates whether the selected section of the menu should be collapsed when clicked.


DisplayHighlightedItemAsLink

Indicates whether highlighted items should be displayed as a link.


EncodeMenuCaption

Indicates whether HTML encoding should be applied to the captions of menu items. Useful only in special cases where the names of the displayed documents contain HTML code.


GenerateAllSubItems

Indicates whether all sub-items should be generated


GenerateIndentationInsideLink

Indicates whether indentation spaces should be generated inside hyperlinks (true) or outside (false). This applies only when you do not use images in the menu.


GenerateOnlyOuterLink

Indicates whether only one outer link should be generated per each menu item.


HighlightedNodePath

Path of the item that should be highlighted as if it were selected. If you omit this value, the control automatically uses the current alias path from the aliaspath querystring parameter.

"/products"

Indentation

Indentation of menu item levels. Number of spaces that will be placed before each level of menu items.


ItemIDPrefix

Prefix placed before each item ID. You can use it to keep IDs unique if you have several CMSTreeMenu controls on the same page.

"submenu"

LoadDataAutomaticaly

Indicates whether data for the control should be loaded automatically. By default, the data is loaded automatically.

 

If you set this property to false, you can enter a custom DataSet into the DataSource property and then call the ReloadData(false) method.


MenuItemImageUrl

URL address of the image that is displayed next to menu items. It may start with "~/" representing the virtual path of the current application.


MenuItemOpenImageUrl

URL address of the image that is displayed next to open menu items. It may start with "~/" representing the virtual path of the current application.


OnMouseOutScript

OnMouseOut script for menu items. You can use macro expressions here.


OnMouseOverScript

OnMouseOver script for menu items. You can use macro expressions here.


OrderBy

Gets or sets the ORDER BY clause of the SQL statement.

 

Please be aware that it is necessary for the root of the displayed tree (or sub-tree) to be first in the resulting order, otherwise all documents may not be displayed correctly. This can be ensured by having the value of this property start with the NodeLevel column, such as in the sample value.

"NodeLevel, NodeOrder"

RenderedHTML

Allows you to get or set the HTML code rendered by the control.

 

You need to set this property before the Render event - e.g. in the OnLoad event.


RenderImageAlt

Indicates whether the ALT attribute should be rendered for images used in the menu (for XHTML compatibility).


RenderLinkTitle

Specifies if the document name should be rendered as a TITLE tag of links (for better accessibility).


RenderSubItems

Indicates whether sub-items should be rendered under the selected item.


UrlTarget

Specifies the target frame for all URLs.

"_blank"

 

Mentioned method:

 

Method Name

Description

ReloadData(bool forceLoad)

Reloads the data.

 

If the forceLoad parameter is set to false and a value is assigned to the DataSource property, the properties of the CMSTreeMenu control are not used and only the data from the DataSource is loaded.