ASP.NET Easy Menu Documentation for .NET - Server side

Methods

Name	Description
AddMenuItem	Adds a new MenuItem to the menu. AddMenuItem(id, innerHtml, icon, url, urlTarget, onClientClick) id - Component ID. innerHtml - Text or HTML to display inside the MenuItem. Optional icon - Icon to display for the MenuItem. Optional url - Url to open when item is clicked. Optional urlTarget - Frame where the url is to be opened. Optional onClientClick - Javascript code to execute when item is clicked. Optional oem.AddMenuItem("menuItem1", "Our Products", null, null, null, null);
AddMenuItemAt	Adds a new MenuItem to the menu at the specified index. AddMenuItemAt(index, id, innerHtml, icon, url, urlTarget, onClientClick) index - The index where the item is to be added to. id - Component ID. innerHtml - Text or HTML to display inside the MenuItem. Optional icon - Icon to display for the MenuItem. Optional url - Url to open when item is clicked. Optional urlTarget - Frame where the url is to be opened. Optional onClientClick - Javascript code to execute when item is clicked. Optional oem.AddMenuItemAt(1, "menuItem1", "Our Products", null, null, null, null);
AddSeparator	Adds a new MenuSeparator to the menu. AddSeparator(id, innerHtml) id - Component ID. innerHtml - Text or HTML to display inside the item. Optional oem.AddSeparator("menuSeparator1", "<hr noshade size= 1>");
AddSeparatorAt	Adds a new MenuSeparator to the menu at the specified index. AddSeparatorAt(index, id, innerHtml) index - The index where the item is to be added to. id - Component ID. innerHtml - Text or HTML to display inside the item. Optional oem.AddSeparatorAt(1, "menuSeparator1", "<hr noshade size= 1>");
AddItem	Adds a new item to the menu. AddItem(item) item - Any control derived from ItemBase to add to the menu. oem.AddItem(new MenuItem("menuItem1", "Our Products"));
AddItemAt	Adds a new item to the menu at the specified index. AddItemAt(index, item) index - The index where the MenuComponent derivate is to be added to. item - Any control derived from ItemBase to add to the menu. oem.AddItemAt(1, new MenuItem("menuItem1", "Our Products"));
RemoveItem	Removes existing item from the menu. RemoveItem(item) item - An existing control derived from ItemBase to remove from the menu. oem.RemoveItem(menuItem1);
RemoveItemAt	Removes existing item from the menu from the specified index. RemoveItemAt(index) index - The index from where the MenuComponent derivate will be removed. oem.RemoveItemAt(1);
RemoveItemByID	Removes existing item with the specified id from the menu. RemoveItemByID(id) id - The menu item id that will be removed. oem.RemoveItemByID("menuItem1");

Menu Settings

Name	Description
Width	The width of the EasyMenu.
AttachTo	Controls IDs to which the menu is to attach itself (separated by commas). Check this tutorial.
ShowEvent	Can take one of the following values: · ContextMenu · MouseClick · DoubleClick · MouseOver · Always
ZIndex	Sets the z-index css property for the menu.
SelectedItemId	The id of the menu item that will be selected.
UseIcons	Specifies whether the menu should use icons.
SelectTreeNode	Specifies whether the TreeView node is selected when context menu is displayed (only in case when menu is attached to a TreeView node).
IconsPosition	Specifies whether the icons should be displayed on the left side or right side of the menu.
Align	EasyMenu's align position. Check this tutorial.
Position	Can take one of the following values: · Horizontal - menu items will be shown one near the other · Vertical - menu items will be shown one under the other
AlignMenuCorner	Can take one of the following values: · BottomLeft · BottomRight · TopLeft · TopRight To use this property, you must setAlign="Advanced". You will also need to set the AlignElementCorner property. The menu will align the AlignMenuCorner to the AlignElementCorner. Align="Advanced" AlignElementCorner="TopRight" AlignMenuCorner="TopLeft"
AlignElementCorner	Can take one of the following values: · BottomLeft · BottomRight · TopLeft · TopRight To use this property, you must set Align="Advanced". You will also need to set the AlignMenuCorner property. The menu will align the AlignMenuCorner to the AlignElementCorner. Align="Advanced" AlignElementCorner="TopRight" AlignMenuCorner="TopLeft"
OffsetHorizontal	Horizontal menu offset relative to the mouse pointer. Check this tutorial.
OffsetVertical	Vertical menu offset relative to the mouse pointer. Check this tutorial.
StyleFolder	Path to the folder containing the style.css file with menu classes.
IconsFolder	Path to the folder containing the icons for the menu.
EventsScriptPath	The path to the client events script file. Check also the menu events tutorial.
EventList	List of comma separated events to call. Check also the menu events tutorial.
KeepOpen	Bool. If true, the menu will stay opened on lost focus. Default: false See also working example.
EqualDivision	Bool. If true, the width of the Horizontal menu will be divided equally among the items. Default: false Here you can see the difference in the menu appearance: EqualDivision="false" : EqualDivision="true" :

Properties - Styles

Name	Description
CSSMenu	The CSS class name of the menu. Optional
CSSMenuItemContainer	The CSS class name of the menu container. Optional
CSSClasses	A CSSClasses object is a collection of css classes names for the different stages of any item that can be added to the menu. It has the following properties: ObjectType - The fully qualified name for the type of the item that this collection refers to. (read only) AppliesTo - The short name for the type of the item that this collection refers to. (read only) Component - The CSS class name for the item. ComponentOver - The CSS class name for the item on mouse over. ComponentLeftRoundCornerCell - The CSS class name for the item's left rounded cell. ComponentLeftRoundCornerCellOver - The CSS class name for the item's left rounded cell on mouse over. ComponentIconCell - The CSS class name for the item's icon cell. ComponentIconCellOver - The CSS class name for the item's icon cell on mouse over. ComponentContentCell - The CSS class name for the item's content cell. ComponentContentCellOver - The CSS class name for the item's content cell on mouse over. ComponentSubMenuCell - The CSS class name for the item's sub menu cell. ComponentSubMenuCellOver - The CSS class name for the item's sub menu cell on mouse over. ComponentRightRoundCornerCell - The CSS class name for the item's right rounded cell. ComponentRightRoundCornerCellOver - The CSS class name for the item's right rounded cell on mouse over. An item is any control derived from ItemBase.
CSSClassesCollection	Collection of CSSClasses. Entries are added automatically to this collection upon adding a new item to the menu. There can be only one CSSClasses entry for a type of item that the menu contains. If an item is added to the menu and a CSSClasses object for it already exists then no new entry is created for it. Example: // a new MenuItem is added to the menu and automatically a new // CSSClasses with ObjectType=MenuItem is added to the // CSSClassesCollection and can be edited oem.AddMenuComponent(new MenuItem("menuItem1", "Our Products")); // a CSSClasses entry for MenuItem type is already in the collection // so a new entry for it is not created oem.AddMenuComponent(new MenuItem("menuItem2", "Our Clients")); // no entry for MenuSeparator is found in the collection so a new // CSSClasses one is created oem.AddMenuComponent(new MenuSeparator("menuSeparator1")); // modify the class name for the MenuItem type // both menuItem1 and menuItem2 will use this new css class name! oem.CSSClassesCollection["MenuItem"].Component = "myNewMenuItemClass";

MenuItem Properties

Name	Description
ID	Component ID.
InnerHtml	Text or HTML to display inside the MenuItem. Optional
AllowsIcon	Whether this MenuItem allows an icon to be displayed for it or not (only used if menu UseIcons is true). Optional
Icon	Icon to display for the MenuItem. Optional
Url	Url to open when item is clicked. Optional
UrlTarget	Frame where the url is to be opened. Optional
Disabled	MenuItem is disabled ("true") or enabled ("false"). Optional
Visible	Specifies whether the menu item is visible or not. Optional
OnClientClick	Javascript code to execute when item is clicked. There are four parameters that can be used to refer to the click event: · targetEl - a reference to the element over which the right click occured · menuObject - a reference to the menu item that was clicked · menuEvent - the event that triggered the item selection (useful for getting cursor information, etc.) · easyMenu - a reference to the EasyMenu to which the clicked option belongs Example: // upon clicking this MenuItem, the id of the element // over which the right click occured will be shown <oem:MenuItem id="menuItem1" OnClientClick="alert(targetEl.id)">Show</oem:MenuItem>
AutoHideMenu	If the menu should auto-hide after the option is clicked. Default is true. Note: If this is set to false, in the script specified by OnClientClick, the menu can be closed using easyMenu.hideMenu();

MenuSeparator Properties

Name	Description
ID	Component ID.
InnerHtml	Text or HTML to display inside the MenuSeparator. Optional
Visible	Specifies whether the menu separator is visible or not. Optional
AllowsIcon	Whether this MenuSeparator allows an icon to be displayed for it or not (only used if menu UseIcons is true). Optional
Icon	Icon to display for the MenuSeparator. Optional