skmMenu: An ASP.NET Menu Control

Menu Members

Menu overview

Public Instance Constructors

Menu ConstructorInitializes a new instance of the Menu class.

Public Instance Properties

AccessKey (inherited from WebControl)Gets or sets the access key (underlined letter) that allows you to quickly navigate to the Web server control.
Attributes (inherited from WebControl) Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.
BackColor (inherited from WebControl)Gets or sets the background color of the Web server control.
BindingContainer (inherited from Control)
BorderColor (inherited from WebControl)Gets or sets the border color of the Web control.
BorderStyle (inherited from WebControl)Gets or sets the border style of the Web server control.
BorderWidth (inherited from WebControl)Gets or sets the border width of the Web server control.
ClickToOpen Specifies whether a submenu is displayed on mouse over or when clicked.
ClientID (inherited from Control) Gets the server control identifier generated by ASP.NET.
Controls (inherited from Control) Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
ControlStyle (inherited from WebControl)Gets the style of the Web server control. This property is used primarily by control developers.
ControlStyleCreated (inherited from WebControl)Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers.
CssClass (inherited from WebControl)Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.
Cursor Sets or Gets the menu's mouse cursor.
DataSource Sets or gets the name of the XML file or XmlDocument object that is the datasource for the menu.
DefaultCssClass Gets or sets the default CSS class name for the MenuItem's CSS class.
DefaultMouseDownCssClass Gets or sets the default value for the menuitem's mouse down css class. Used when a menuitem has no value specified.
DefaultMouseOverCssClass Gets or sets the default value for the menuitem's mouse over css class. Used when a menuitem has no value specified.
DefaultMouseUpCssClass Gets or sets the default value for the menuitem's mouse up css class. Used when a menuitem has no value specified.
DefaultResolveURL Specifies whether URL's should be resolved before being output.
DefaultTarget Gets or sets the default target for links in menuitems. Used if no target property is specified for a menuitem.
Enabled (inherited from WebControl)Gets or sets a value indicating whether the Web server control is enabled.
EnableViewState (inherited from Control) Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.
Font (inherited from WebControl)Gets the font properties associated with the Web server control.
ForeColor (inherited from WebControl)Gets or sets the foreground color (typically the color of the text) of the Web server control.
GridLines Sets or Gets the menu's gridline property.
Height (inherited from WebControl)Gets or sets the height of the Web server control.
HighlightTopMenu Specifies whether the top level menu should remain highlighted when the submenu beneath is displayed.
ID (inherited from Control) Gets or sets the programmatic identifier assigned to the server control.
IFrameSrc Specifies what SRC property should be loaded into an IFRAME.
ItemPadding Gets or sets padding for each menuitem (pixels).
Items Returns the Menu's top-level MenuItems.
ItemSpacing Gets or sets the spacing for each menuitem (pixels).
Layout Sets or Gets the menu's layout direction.
MenuFadeDelay Gets or sets the number of half seconds to display the menu after the user's mouse has left the menu, before hiding the menu.
NamingContainer (inherited from Control) Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value.
Opacity Gets or sets the opacity style value for the menu.
Page (inherited from Control) Gets a reference to the Page instance that contains the server control.
Parent (inherited from Control) Gets a reference to the server control's parent control in the page control hierarchy.
ScriptPath Gets or sets the path to an external JavaScript file. If no external path is specified, the JavaScript is rendered by the control directly in the page.
SelectedMenuItemStyle Specifies the style for selected MenuItems.
Site (inherited from Control) Gets information about the Web site to which the server control belongs.
Style (inherited from WebControl) Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.
SubMenuCssClass Gets or sets the value for css class used for SubMenus.
TabIndex (inherited from WebControl) Gets or sets the tab index of the Web server control.
TemplateSourceDirectory (inherited from Control) Gets the virtual directory of the Page or UserControl that contains the current server control.
ToolTip (inherited from WebControl) Gets or sets the text displayed when the mouse pointer hovers over the Web server control.
UniqueID (inherited from Control) Gets the unique, hierarchically-qualified identifier for the server control.
UnselectedMenuItemStyle Specifies the style for unselected MenuItems.
UserRoles Specifies the roles the current user belongs to. When assigning roles to the MenuItems, the user's roles affect what menu items are displayed.
Visible (inherited from Control) Gets or sets a value that indicates whether a server control is rendered as UI on the page.
Width (inherited from WebControl)Gets or sets the width of the Web server control.
zIndex Gets or sets the z-index style value for the menu.

Public Instance Methods

ApplyStyle (inherited from WebControl) Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers.
CopyBaseAttributes (inherited from WebControl)Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers.
DataBind (inherited from Control) Binds a data source to the invoked server control and all its child controls.
Dispose (inherited from Control) Enables a server control to perform final clean up before it is released from memory.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
FindControl (inherited from Control)Overloaded. Searches the current naming container for a server control with the specified id parameter.
GetHashCode (inherited from Object)Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object)Gets the Type of the current instance.
HasControls (inherited from Control)Determines if the server control contains any child controls.
MergeStyle (inherited from WebControl) Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers.
RenderBeginTag (inherited from WebControl) Renders the HTML opening tag of the control into the specified writer. This method is used primarily by control developers.
RenderControl (inherited from Control)Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.
RenderEndTag (inherited from WebControl)Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers.
ResolveUrl (inherited from Control)Converts a URL into one that is usable on the requesting client.
SetRenderMethodDelegate (inherited from Control)
ToString (inherited from Object)Returns a String that represents the current Object.

Public Instance Events

DataBinding (inherited from Control) Occurs when the server control binds to a data source.
Disposed (inherited from Control) Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.
Init (inherited from Control) Occurs when the server control is initialized, which is the first step in the its lifecycle.
Load (inherited from Control)Occurs when the server control is loaded into the Page object.
MenuItemClick Occurs when a MenuItem associated with a command is clicked.
PreRender (inherited from Control)Occurs when the server control is about to render to its containing Page object.
Unload (inherited from Control) Occurs when the server control is unloaded from memory.

Protected Instance Properties

ChildControlsCreated (inherited from Control)Gets a value that indicates whether the server control's child controls have been created.
Context (inherited from Control)Gets the HttpContext object associated with the server control for the current Web request.
Events (inherited from Control)Gets a list of event handler delegates for the control. This property is read-only.
ExternalScriptUrl Return the configured URL for the external script.
HasChildViewState (inherited from Control) Gets a value indicating whether the current server control's child controls have any saved view-state settings.
IsTrackingViewState (inherited from Control)Gets a value that indicates whether the server control is saving changes to its view state.
TagKey (inherited from WebControl)Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers.
TagName (inherited from WebControl) Gets the name of the control tag. This property is used primarily by control developers.
UseExternalScript A helper method that determines if an external script is being used.
ViewState (inherited from Control)Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.
ViewStateIgnoresCase (inherited from Control)Gets a value that indicates whether the StateBag object is case-insensitive.

Protected Instance Methods

AddAttributesToRender (inherited from WebControl) Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriter. This method is used primarily by control developers.
AddMenu AddMenu is called recusively, doing a depth-first traversal of the menu hierarchy and building up the HTML elements from the object model.
AddParsedSubObject (inherited from Control)Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.
BuildImagePreload Determines what images are used by a specified MenuItem instance.
BuildMenu BuildMenu builds the top-level menu. It is called from the OnDataBinding method as well as from CreateChildControls. It has code to check if the top-level menu should be laid out horizontally or vertically.
BuildMenuID Creates a MenuID for a MenuItem.
BuildMenuItem This method creates a single MenuItem and is called repeatedly from GatherMenuItems.
BuildMenuSpacer Creates a MenuItem spacer.
BuildProfileTree (inherited from Control)
ClearChildViewState (inherited from Control) Deletes the view-state information for all the server control's child controls.
CreateChildControls This method is called from base.Render(), and starts the build menu process.
CreateControlCollection (inherited from Control)Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.
CreateControlStyle (inherited from WebControl) Creates the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers.
EnsureChildControls (inherited from Control) Determines whether the server control contains child controls. If it does not, it creates child controls.
Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
FindControl (inherited from Control)Overloaded.
GatherMenuItems This method is used from the OnDataBinding method; it traverses the XML document, building up the object model.
GenerateShimCall For Internet Explorer 5.5 and up, IFRAMEs are used. This method returns the client-side JavaScript to show/hide the IFRAME.
InstantiateStyleInfoJavascript Returns the javascript that instantiates a style info object that corresponds to the style specified.
IsLiteralContent (inherited from Control) Determines if the server control holds only literal content.
LoadViewState Loads the state from the passed in saveState object. This method runs during the page life-cycle, and is required for the menu to work across postbacks.
MapPathSecure (inherited from Control)Retrieves the physical path that a virtual path, either absolute or relative, maps to.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.
OnBubbleEvent (inherited from Control) Determines whether the event for the server control is passed up the page's UI server control hierarchy.
OnDataBinding Event handler for the DataBinding event.
OnInit (inherited from Control)Raises the Init event.
OnLoad (inherited from Control)Raises the Load event.
OnMenuItemClick Raises the MenuItemClick event. This allows you to provide a custom handler for the event.
OnPreRender Generates the client-side JavaScript.
OnUnload (inherited from Control)Raises the Unload event.
Note    Server controls should perform any final cleanup, such as closing files, closing database connections, and discarding objects, during this stage of the server control lifecycle.
RaiseBubbleEvent (inherited from Control) Assigns any sources of the event and its information to the control's parent.
RegisterClientScriptBlock Registers the main client script.
RegisterClientStartupScript Registers the startup client script.
RegisterPreloadCommand Registers the Preload command to preload any images.
RegisterSubmenuArray Registers the SubMenus for the menu with a JavaScript array.
Render The Render method is responsible for generating the HTML markup.
RenderChildren (inherited from Control)Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.
RenderContents (inherited from WebControl)Renders the contents of the control into the specified writer. This method is used primarily by control developers.
SaveViewState SaveViewState saves the state of the menu into an object (specifically, an object array with five indices). This is required to have the state persisted across postbacks.
TrackViewState TrackViewState informs all of the menus complex properties that they, too, need to track their viewstate changes.
UserHasPermission Determines if a user belongs to a role for a particular MenuItem.

Protected Internal Instance Methods

AddedControl (inherited from Control) Called after a control is added to the Controls collection of another control.
RemovedControl (inherited from Control) Called after a control is removed from the Controls collection of another control.

Explicit Interface Implementations

IAttributeAccessor.GetAttribute (inherited from WebControl)
IAttributeAccessor.SetAttribute (inherited from WebControl)
IParserAccessor.AddParsedSubObject (inherited from Control)
IPostBackEventHandler.RaisePostBackEvent

See Also

Menu Class | skmMenu Namespace