RadMenu for ASP.NET

API reference (skinning whitepaper) Send comments on this topic.
DNN > API reference (skinning whitepaper)

Glossary Item Box

Attribute Value Description
RadControlsDir

The location of the RadControls folder for RadMenu

ExpandAnimationType and ExpandAnimationDuration AnnimationSettings that represent the expand animation.

Gets the settings for the animation played when an item opens.

CollapseAnimationType and CollapseAnimationDuration An AnnimationSettings that represents the collapse animation.

Gets the settings for the animation played when an item closes.

IsContext False a value indicating whether the menu is context or not.
EnableScreenBoundaryDetection a value indicating whether the screen boundary detection will be applied when expanded.
ContextMenuElementID the ID of the html element which if right-clicked will display the context menu.
ClickToOpen True if the root items open on mouse click; otherwise false. The default value is false. a value indicating whether root items should open on mouse click.
SkinsPath A string specifying the relative path to the folder which contains RadMenu skins. The default value is "~/RadControls/Menu/Skins". the relative path of the folder containing the skins. This property accepts the *SkinPath* token.
Skin A String specifying the skin. The default value is Default. the skin used by RadMenu.
CausesValidation true if validation is performed when an item is selected; otherwise, false. The default value is true. a value indicating whether validation is performed when an item within the RadMenu control is selected.
ExpandDelay An integer specifying the timeout measured in milliseconds. The default value is 0 which means that menu items open immediately. a value indicating the timeout after which a menu item starts to open.
Flow One of the ItemFlow values. The default value for top level items is Horizontal. a value indicating the way top level items will flow.
CollapseDelay An integer specifying the timeout measured in milliseconds. The default value is 500 (half a second). a value indicating the timeout after which a menu item starts to close.
OnClientMouseOver A string specifying the name of the JavaScript function that will handle the event. The default value is empty string. a value indicating the client-side event handler that is called when the mouse moves over a menu item in the RadMenu control.
OnClientMouseOut A string specifying the name of the JavaScript function that will handle the event. The default value is empty string. a value indicating the client-side event handler that is called when the mouse moves out of a menu item in the RadMenu control.
OnClientItemFocus A string specifying the name of the JavaScript function that will handle the event. The default value is empty string. a value indicating the client-side event handler that is called when a menu item gets focus.
OnClientItemBlur A string specifying the name of the JavaScript function that will handle the event. The default value is empty string. a value indicating the client-side event handler that is called after an item loses focus.
OnClientItemClicking A string specifying the name of the JavaScript function that will handle the event. The default value is empty string. a value indicating the client-side event handler that is called when a menu item is clicked.
OnClientItemClicked A string specifying the name of the JavaScript function that will handle the event. The default value is empty string. a value indicating the client-side event handler that is called after a menu item is clicked.
OnClientItemOpen A string specifying the name of the JavaScript function that will handle the event. The default value is empty string. a value indicating the client-side event handler that is called when a group of child items opens.
OnClientItemClose A string specifying the name of the JavaScript function that will handle the event. The default value is empty string. a value indicating the client-side event handler that is called when a group of child items closes.
OnClientLoad A string specifying the name of the JavaScript function that will handle the event. The default value is empty string. a value indicating the client-side event handler that is called after the RadMenu client-side object is initialized.
CssClass A CSS class to be applied to the menu
Style A list of style properties for the menu
Height sets the height of RadMenu
Width sets the width of RadMenu
ItemCssClass If using the item or level css options of the skinobject then the level and item number will be added to the name of the CSS class.
ItemDisabledCssClass The CSS class applied when the menu item is disabled. The default value is "disabled". the Cascading Style Sheet (CSS) class applied when the menu item is disabled. If using the item or level css options of the skinobject then the level and item number will be added to the name of the CSS class.
ItemExpandedCssClass The CSS class applied when the menu item is opened. The default value is "expanded". the Cascading Style Sheet (CSS) class applied when the menu item is opened (its child items are visible). If using the item or level css options of the skinobject then the level and item number will be added to the name of the CSS class.
ItemFocusedCssClass The CSS class applied when the menu item is focused. The default value is "focused". the Cascading Style Sheet (CSS) class applied when the menu item is focused. If using the item or level css options of the skinobject then the level and item number will be added to the name of the CSS class.
ItemClickedCssClass The CSS class applied when the menu item is clicked. The default value is "clicked". the Cascading Style Sheet (CSS) class applied when the menu item is clicked. If using the item or level css options of the skinobject then the level and item number will be added to the name of the CSS class.
ItemImageUrl The path to the image to display for the item. The default value is empty string. the path to an image to display for the item. This property accepts the special tokens *SkinPath* and *PageName*.
ItemHoveredImageUrl The path to the image to display when the user moves the mouse over the item. The default value is empty string. the path to an image to display for the item when the user moves the mouse over the item. This property accepts the special tokens *SkinPath* and *PageName*.
ItemTarget The target window or frame to load the Web page linked to when the Item is selected the target window or frame to display the Web page content linked to when the menu item is clicked.
ItemBackColor inherited from the default webcontrol class
ItemBorderColor inherited from the default webcontrol class
ItemBorderWidth inherited from the default webcontrol class
ItemBorderStyle inherited from the default webcontrol class
ItemForeColor inherited from the default webcontrol class
ItemHeight inherited from the default webcontrol class
ItemWidth inherited from the default webcontrol class
RootItemCssClass If using the item or level css options of the skinobject then the level and item number will be added to the name of the CSS class.
RootItemDisabledCssClass The CSS class applied when the menu item is disabled. The default value is "disabled". the Cascading Style Sheet (CSS) class applied when the menu item is disabled. If using the item or level css options of the skinobject then the level and item number will be added to the name of the CSS class.
RootItemExpandedCssClass The CSS class applied when the menu item is opened. The default value is "expanded". the Cascading Style Sheet (CSS) class applied when the menu item is opened (its child items are visible). If using the item or level css options of the skinobject then the level and item number will be added to the name of the CSS class.
RootItemFocusedCssClass The CSS class applied when the menu item is focused. The default value is "focused". the Cascading Style Sheet (CSS) class applied when the menu item is focused. If using the item or level css options of the skinobject then the level and item number will be added to the name of the CSS class.
RootItemClickedCssClass The CSS class applied when the menu item is clicked. The default value is "clicked". the Cascading Style Sheet (CSS) class applied when the menu item is clicked. If using the item or level css options of the skinobject then the level and item number will be added to the name of the CSS class.
RootItemImageUrl The path to the image to display for the item. The default value is empty string. the path to an image to display for the item. This property accepts the special tokens *SkinPath* and *PageName*.
RootItemHoveredImageUrl The path to the image to display when the user moves the mouse over the item. The default value is empty string. the path to an image to display for the item when the user moves the mouse over the item. This property accepts the special tokens *SkinPath* and *PageName*.
RootItemTarget The target window or frame to load the Web page linked to when the Item is selected the target window or frame to display the Web page content linked to when the menu item is clicked.
RootItemBackColor inherited from the default webcontrol class
RootItemBorderColor inherited from the default webcontrol class
RootItemBorderWidth inherited from the default webcontrol class
RootItemBorderStyle inherited from the default webcontrol class
RootItemForeColor inherited from the default webcontrol class
RootItemHeight inherited from the default webcontrol class
RootItemWidth inherited from the default webcontrol class
GroupFlow One of the ItemFlow enumeration values. The default value is Vertical. the flow of child items.
GroupExpandDirection One of the ExpandDirection enumeration values. The default value is Auto. Other possible values are: Up, Left, Right and Down(same as Auto) the direction in which child items will open.
GroupOffsetX An integer specifying the horizontal offset of child menu items (measured in pixels). The default value is 0 (no offset). a value indicating the horizontal offset of child menu items considering their parent.
GroupOffsetY An integer specifying the vertical offset of child menu items (measured in pixels). The default value is 0 (no offset). a value indicating the vertical offset of child menu items considering their parent.
GroupWidth A Unit that represents the width of the child item group. The default value is Unit.Empty. a value indicating the width of child menu items (the whole item group).
GroupHeight A Unit that represents the height of the child item group. The default value is Unit.Empty. a value indicating the height of child menu items (the whole item group).
SelectedPathHeaderItemCss The CSS class for the root group item that is currently selected or one of it's children is currently selected
SelectedPathItemCss The CSS class for the item that is currently selected or one of its children is selected. Note: does not apply to the root menu group. See SelectedPathHeaderItemCss.
SelectedPathItemImage This image(breadcrumb) will be shown if the menu item or one of its children items is selected. The image accepts the tokens *PageName* and *SkinPath*.
SelectedPathHeaderItemImage This image(breadcrumb) will be shown if the menu item or one of its children items is selected. The image accepts the tokens *PageName* and *SkinPath*.
EnableToolTips False If set to true, the page description will be displayed as a tooltip when you hover over the menu item.
ImagesOnlyMenu False The menu item uses the icon file specified for the page instead of the page name. However, if no icon file is specified, then the page name is used as the item text.
EnableLevelCss False If set to true, "Level" and the level of the menuitem will be added to the beginning of its CSS class. Works for ItemCssClass, ItemCssClassOver, ItemCssClassClicked, ItemCssClassDisabled. For example: if ItemCssClass = "menu_item" then the menu will use "Level0menu_item" for the root group of items, "Level1menu_item" for the level 1 items and so on.
EnableItemCss False If set to true, each item in the menu that is not in the root group will have its CSS class changed according to the position of that item in the menu group. The number will be appended in the end of the CSS classes ItemCssClass, ItemCssClassOver, ItemCssClassClicked, ItemCssClassDisabled. For example: if ItemCssClass = "menu_item" then the menu will use "menu_item1" for the first item, "menu_item2" for the second and so on. This property can be combined with EnableLevelCss.
EnableRootItemCss False If set to true, each item in the root menu will have its CSS class changed according to the position of that item in the group. The number will be appended in the end of the CSS classes ItemCssClass, ItemCssClassOver, ItemCssClassClicked, ItemCssClassDisabled. For example: if ItemCssClass = "menu_item" then the menu will use "menu_item1" for the first item, "menu_item2" for the second and so on. This property can be combined with EnableLevelCss.
MaxLevelNumber 10 If EnableGroupLevelCss or EnableLevelCss are set to True, this property limits the number of levels that will use the modified CSS classes. If there are more levels after MaxLevelNumber, their CSS classes will be the default ones. For example when MaxLevelNumber = 3 and ItemCssClass = "menu_item" all items after level 3 will have their ItemCssClass set to "menu_item", while all items below level 3 will have the ItemCssClass and the value of the level "Level0menu_item"," Level0menu_item" etc.
MaxItemNumber 20 If EnableItemCss or EnableRootItemCss are set to True, this property limits the number of items that will use the modified CSS classes. If there are more levels after MaxLevelNumber, their CSS classes will be the default ones. For example when MaxItemNumber = 3 and ItemCssClass = "menu_item" all items after the third one will have their ItemCssClass set to "menu_item", while the first three will have the ItemCssClass and the order of the item - "menu_item1","menu_item2", "menu_item3".
MaxLevel The maximum number of levels to display. Useful if you have a big menu and would like to show only a part of it. If set to 0 only the root group will be shown.
ShowOnlyCurrent If set to "ChildItems" the menu will render only the child items of the current page. If set to "CurrentItem" it will render child items plus the current page. If set to "RootItem" then the menu will render all child items of the root group item that is selected or is a part of the path to the currently selected menu item. If you specify a Page ID, the menu will display only the child items of the specified page. You can also specify a the name of the page instead of its ID- the format is "PageItem:Home"(where "Home" is the page name). Allowed values are "CurrentItem", "RootItem", and the ID or name of a DNN Page.
EnableItemId False If set to "True", the menu will generate an ID property for each menu item. The ID will have a value "M_" + the database ID of the page. For example "M_36"
EnablePageIcons True Specifies whether to show the page icons as a left logo of the menu item.
HeaderFirstItem An image to be displayed at the start of the header menu group. Can contain the token *SkinPath*, which will be replaced with the current skin's path.
HeaderSeparator An image to be displayed between the menu items in the header group. Can contain the token *SkinPath*, which will be replaced with the current skin's path.
HeaderLastItem An image to be displayed at the end of the header menu group. Can contain the token *SkinPath*, which will be replaced with the current skin's path.
HeaderFirstItemCssClass A CSS class name, which will be applied to HeaderFirstItem.
HeaderFirstItemCssClassClicked A CSS class name, which will be applied to HeaderFirstItem when the user clicks on it.
HeaderFirstItemCssClassOver A CSS class name, which will be applied to HeaderFirstItem when the mouse hovers over it.
HeaderSeparatorCssClass A CSS class name, which will be applied to HeaderSeparator.
HeaderSeparatorCssClassClicked A CSS class name, which will be applied to HeaderSeparator when the user clicks on it.
HeaderSeparatorCssClassOver A CSS class name, which will be applied to HeaderSeparator when the mouse hovers over it.
HeaderLastItemCssClass A CSS class name, which will be applied to HeaderLastItem .
HeaderLastItemCssClassClicked A CSS class name, which will be applied to HeaderLastItem when the user clicks on it.
HeaderLastItemCssClassOver A CSS class name, which will be applied to HeaderLastItem when the mouse hovers over it.
childGroupFirstItem An image to be displayed at the start of a child menu group. Can contain the token *SkinPath*, which will be replaced with the current skin's path.
childGroupSeparator An image to be displayed between the menu items in a child group. Can contain the token *SkinPath*, which will be replaced with the current skin's path.
childGroupLastItem An image to be displayed at the end of a child menu group. Can contain the token *SkinPath*, which will be replaced with the current skin's path.
childGroupFirstItemCssClass A CSS class name, which will be applied to childGroupFirstItem.
childGroupFirstItemCssClassClicked A CSS class name, which will be applied to childGroupFirstItem when the user clicks on it.
childGroupFirstItemCssClassOver A CSS class name, which will be applied to childGroupFirstItem when the mouse hovers over it.
childGroupSeparatorCssClass A CSS class name, which will be applied to childGroupSeparator.
childGroupSeparatorCssClassClicked A CSS class name, which will be applied to childGroupSeparator when the user clicks on it.
childGroupSeparatorCssClassOver A CSS class name, which will be applied to childGroupSeparator when the mouse hovers over it.
childGroupLastItemCssClass A CSS class name, which will be applied to childGroupLastItem.
childGroupLastItemCssClassClicked A CSS class name, which will be applied to childGroupLastItem when the user clicks on it.
childGroupLastItemCssClassOver A CSS class name, which will be applied to childGroupLastItem when the mouse hovers over it.
EnableUserMenus True A Boolean parameter, specifying whether or not to show the normal(non-admin) menu pages in the menu.
EnableAdminMenus True A Boolean parameter, specifying whether or not to show the admin(Admin and Host) pages in the menu.
CopyChildItemLink False Some menu items have disabled links(for example "Admin", "Host" etc.). If you have a menu with MaxLevel=0, then these menus will be inaccessible because you cannot click on "Admin" or "Host" items. With this option set to True, all menu items that do not correspond to a page will point to their first child item. For example clicking on the Admin menu will redirect the user to "Admin>Site Settings"(the first child page in the admin menu).
ShowPath False If set to true, the current page item and its parents will be displayed as focused. You can change the default CSS class using the SelectedPath skinobject attributes.
PagesToExclude A comma-separated list of pages IDs OR Names that will NOT be included in the menu navigation control.