Click here to Skip to main content
65,938 articles
CodeProject is changing. Read more.
Articles / web / HTML

MenuPilot 1.0 (Open-Source Context Menu for ASP.NET 2.0)

4.94/5 (60 votes)
23 Dec 20063 min read 1   1.2K  
Fine DHTML context menu with layout of Action Lists/Smart Tags known from Visual Studio .NET 2005

Image 1

Introduction

Use case #1: GridView action items

This control allows you to replace this table:

Image 2

with a much more simple one:

Image 3

Use case #2: Image actions

MenuPilot supports task menus for images as well. You can replace this UI:

Image 4

with a more compact one:

Image 5

This is especially useful if you have a page full of images and there is no space for action links.

MenuPilot Features

  • Customizable hint icon
  • Customizable colors
  • Supports data binding
  • Supports menu item separators
  • Full Visual Studio .NET 2005 design-time support
  • Compiled for ASP.NET 2.0
  • Available for three inline ASP.NET controls: HyperLink, Label and Image
  • Menu items support title and target link attributes
  • Menu items can execute JavaScript or go to a URL
  • Includes fix for Internet Explorer z-index bug
  • Includes fix for Internet Explorer windowed controls z-index bug

How it works

There is nothing complicated about the concept:

  • There are two hidden elements drawn for a MenuPilot control: the "hint icon" and the "task menu".
  • The "hint icon" appears when a user hovers over the control with a mouse (onmouseover event).
  • The "task menu" appears when a user clicks on the hint icon.
  • Both the hint icon and the task menu disappear when the user moves the mouse out of the menu.

What's required to make it work

However, there are a lot of tasks that need to be done in order to make it work nicely:

  1. It is necessary to wait some time before the hint icon is activated after the onmouseover event. It is also necessary to wait some before it is deactivated after the onmouseout event:
    JavaScript
    function __menuPilot_activateLabel(o)
    {
      if (__menuPilot_activeId != o.id)
        __menuPilot_clearNow();
    
      if (__menuPilot_t != null)
        clearTimeout(__menuPilot_t);
    
      __menuPilot_waitingFor = o.id;
      __menuPilot_t = setTimeout(__menuPilot_activateLabelLater, 100);
    }
    
    function __menuPilot_activateLabelLater() 
    {
      document.getElementById(__menuPilot_waitingFor + 'down').style.display = '';
      __menuPilot_activeId = __menuPilot_waitingFor;
    }
  2. It is necessary to deactivate the hint icon and the task menu when a user hovers over another MenuPilot control:

    All the necessary <span> elements (i.e. the main text <span>, hint icon <span> and menu <span>) call the following function on onmouseout event:

    JavaScript
    function __menuPilot_clearAll()
    {
      if (__menuPilot_t != null)
        clearTimeout(__menuPilot_t);
      __menuPilot_t = setTimeout(__menuPilot_clearNow, 300);
    }
    
    function __menuPilot_clearNow()
    {
      var id = __menuPilot_activeId;
      if (id == null)
        return;
      __menuPilot_deactivateLabel(document.getElementById(id));
      __menuPilot_deactivateMenu(document.getElementById(id + 'menu'));
      __menuPilot_activeId = null;
      __menuPilot_isActiveMenu = false;
    }
  3. It is necessary to draw the menu over all <select> elements in Internet Explorer:

    There is a workaround available for an IE bug that draws all <select> elements always on the top (i.e. over the menu). See http://dotnetjunkies.com/WebLog/jking/archive/2003/10/30/2975.aspx

The controls

There are three controls available in MenuPilot:

  • MenuPilotHyperLink
  • MenuPilotLabel
  • MenuPilotImage

They are derived from standard HyperLink, Label, and Image controls so all the standard functionality is available.

C#
[PersistChildren(false)]
[ParseChildren(true, "MenuItems")]
[DefaultProperty(null)]
[Designer(typeof(ControlDesigner))]
[ToolboxBitmap(typeof(HyperLink))]
public class MenuPilotHyperlink : HyperLink
{
//...

It only adds the customization properties:

PropertyTypeDescriptionDefault value
AppearAfterSystem.Int32Number of milliseconds to wait before the hint icon appears.100
DisappearAfterSystem.Int32Number of milliseconds to wait before the menu disappears.500
HintIconSystem.StringPath of the hint icon."action.gif"
HintIconHeightSystem.Int32Hint icon height in pixels.11
HintIconWidthSystem.Int32Hint icon width in pixels.11
MenuActionColorSystem.Drawing.ColorColor of the task menu items (hyperlinks).#2859AB
MenuBackColorSystem.Drawing.ColorColor of the task menu background.#F0EEE1
MenuBorderColorSystem.Drawing.ColorColor of the task menu border#ACA899
MenuFontSizeSystem.StringTask menu font size (CSS syntax).8pt
MenuItemsMenuPilot.Web.Ui.<br />MenuItemCollectionCollection of menu items.null
MenuTitleSystem.StringTitle of the task menu."Tasks"
MenuTitleBackColorSystem.Drawing.ColorColor of the task menu title background.#C1D2EE
ValueSystem.StringBindable string property that is used for passing some value to menu item hyperlinks.null

Acknowledgements

  • Joe King Sample for using a DIV IFRAME shim to cover over SELECT Boxes and other windowed controls in IE

Resources

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here