SubMenuStyle Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents the style of a submenu in a Menu control.
public ref class SubMenuStyle : System::Web::UI::WebControls::Style, System::ComponentModel::ICustomTypeDescriptorpublic class SubMenuStyle : System.Web.UI.WebControls.Style, System.ComponentModel.ICustomTypeDescriptortype SubMenuStyle = class
inherit Style
interface ICustomTypeDescriptorPublic Class SubMenuStyle
Inherits Style
Implements ICustomTypeDescriptor- Inheritance
- Implements
Examples
The following example demonstrates how to specify a custom style for a submenu within a dynamic menu.
<%@ Page Language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>Menu DynamicMenuStyle Example</title>
</head>
<body>
<form id="form1" runat="server">
<h3>Menu DynamicMenuStyle Example</h3>
<asp:menu id="NavigationMenu"
staticdisplaylevels="2"
staticsubmenuindent="10"
orientation="Vertical"
target="_blank"
runat="server">
<dynamicmenustyle backcolor="LightSkyBlue"
forecolor="Black"
borderstyle="Solid"
borderwidth="1"
bordercolor="Black" />
<items>
<asp:menuitem navigateurl="Home.aspx"
text="Home"
tooltip="Home">
<asp:menuitem navigateurl="Music.aspx"
text="Music"
tooltip="Music">
<asp:menuitem navigateurl="Classical.aspx"
text="Classical"
tooltip="Classical"/>
<asp:menuitem navigateurl="Rock.aspx"
text="Rock"
tooltip="Rock"/>
<asp:menuitem navigateurl="Jazz.aspx"
text="Jazz"
tooltip="Jazz"/>
</asp:menuitem>
<asp:menuitem navigateurl="Movies.aspx"
text="Movies"
tooltip="Movies">
<asp:menuitem navigateurl="Action.aspx"
text="Action"
tooltip="Action"/>
<asp:menuitem navigateurl="Drama.aspx"
text="Drama"
tooltip="Drama"/>
<asp:menuitem navigateurl="Musical.aspx"
text="Musical"
tooltip="Musical"/>
</asp:menuitem>
</asp:menuitem>
</items>
</asp:menu>
</form>
</body>
</html>
<%@ Page Language="VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>Menu DynamicMenuStyle Example</title>
</head>
<body>
<form id="form1" runat="server">
<h3>Menu DynamicMenuStyle Example</h3>
<asp:menu id="NavigationMenu"
staticdisplaylevels="2"
staticsubmenuindent="10"
orientation="Vertical"
target="_blank"
runat="server">
<dynamicmenustyle backcolor="LightSkyBlue"
forecolor="Black"
borderstyle="Solid"
borderwidth="1"
bordercolor="Black" />
<items>
<asp:menuitem navigateurl="Home.aspx"
text="Home"
tooltip="Home">
<asp:menuitem navigateurl="Music.aspx"
text="Music"
tooltip="Music">
<asp:menuitem navigateurl="Classical.aspx"
text="Classical"
tooltip="Classical"/>
<asp:menuitem navigateurl="Rock.aspx"
text="Rock"
tooltip="Rock"/>
<asp:menuitem navigateurl="Jazz.aspx"
text="Jazz"
tooltip="Jazz"/>
</asp:menuitem>
<asp:menuitem navigateurl="Movies.aspx"
text="Movies"
tooltip="Movies">
<asp:menuitem navigateurl="Action.aspx"
text="Action"
tooltip="Action"/>
<asp:menuitem navigateurl="Drama.aspx"
text="Drama"
tooltip="Drama"/>
<asp:menuitem navigateurl="Musical.aspx"
text="Musical"
tooltip="Musical"/>
</asp:menuitem>
</asp:menuitem>
</items>
</asp:menu>
</form>
</body>
</html>
Remarks
Use the SubMenuStyle class to represent the style of a submenu in the Menu control. A submenu can be displayed within either a static menu or a dynamic menu. A static menu is always visible on a Menu control, whereas a dynamic menu is displayed only when the user positions the mouse pointer over a parent menu item that contains a dynamic submenu. You can specify different style characteristics (such as font size and color) for the submenus within a static menu and a dynamic menu by using the properties in the following table.
| Submenu item style property | Description |
|---|---|
| DynamicMenuStyle | The style settings for a submenu within a dynamic menu. |
| StaticMenuStyle | The style settings for a submenu within a static menu. |
The SubMenuStyle class inherits most of its members from the Style class. It extends the Style class by providing properties that control the amount of space around a menu item's text. Use the HorizontalPadding property to control the amount of space to the left and right of the menu item's text. Similarly, the VerticalPadding property controls the amount of space above and below the menu item's text.
For more information on the inherited style settings, see Style.
Note
Set the z-index of HTML objects that are associated with a submenu by setting the CssClass property of the submenu style. The z-index attribute defines the stacking order of rendered HTML objects. By default, dynamic menu items will appear above any HTML object that has the default z-index (0).
Constructors
| SubMenuStyle() |
Initializes a new instance of the SubMenuStyle class. |
| SubMenuStyle(StateBag) |
Initializes a new instance of the SubMenuStyle class with the specified view-state information. |
Properties
| BackColor |
Gets or sets the background color of the Web server control. (Inherited from Style) |
| BorderColor |
Gets or sets the border color of the Web server control. (Inherited from Style) |
| BorderStyle |
Gets or sets the border style of the Web server control. (Inherited from Style) |
| BorderWidth |
Gets or sets the border width of the Web server control. (Inherited from Style) |
| CanRaiseEvents |
Gets a value indicating whether the component can raise an event. (Inherited from Component) |
| Container |
Gets the IContainer that contains the Component. (Inherited from Component) |
| CssClass |
Gets or sets the cascading style sheet (CSS) class rendered by the Web server control on the client. (Inherited from Style) |
| DesignMode |
Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component) |
| Events |
Gets the list of event handlers that are attached to this Component. (Inherited from Component) |
| Font |
Gets the font properties associated with the Web server control. (Inherited from Style) |
| ForeColor |
Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from Style) |
| Height |
Gets or sets the height of the Web server control. (Inherited from Style) |
| HorizontalPadding |
Gets or sets the amount of space to the left and right of a submenu. |
| IsEmpty |
A protected property. Gets a value indicating whether any style elements have been defined in the state bag. (Inherited from Style) |
| IsTrackingViewState |
Returns a value indicating whether any style elements have been defined in the state bag. (Inherited from Style) |
| RegisteredCssClass |
Gets the cascading style sheet (CSS) class that is registered with the control. (Inherited from Style) |
| Site |
Gets or sets the ISite of the Component. (Inherited from Component) |
| VerticalPadding |
Gets or sets the amount of space above and below a submenu. |
| ViewState |
Gets the state bag that holds the style elements. (Inherited from Style) |
| Width |
Gets or sets the width of the Web server control. (Inherited from Style) |
Methods
| AddAttributesToRender(HtmlTextWriter, WebControl) |
Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriter and Web server control. This method is primarily used by control developers. (Inherited from Style) |
| AddAttributesToRender(HtmlTextWriter) |
Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriter. This method is primarily used by control developers. (Inherited from Style) |
| CopyFrom(Style) |
Copies the style properties of the specified Style object into the current instance of the SubMenuStyle class. |
| CreateObjRef(Type) |
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject) |
| Dispose() |
Releases all resources used by the Component. (Inherited from Component) |
| Dispose(Boolean) |
Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from Component) |
| Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
| FillStyleAttributes(CssStyleCollection, IUrlResolutionService) |
Adds the style properties of the SubMenuStyle object to the specified CssStyleCollection object. |
| GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
| GetLifetimeService() |
Obsolete.
Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| GetService(Type) |
Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component) |
| GetStyleAttributes(IUrlResolutionService) |
Retrieves the CssStyleCollection object for the specified IUrlResolutionService-implemented object. (Inherited from Style) |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| InitializeLifetimeService() |
Obsolete.
Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| LoadViewState(Object) |
Loads the previously saved state. (Inherited from Style) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| MemberwiseClone(Boolean) |
Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject) |
| MergeWith(Style) |
Combines the style properties of the specified Style object with those of the current instance of the SubMenuStyle class. |
| Reset() |
Returns the current instance of the SubMenuStyle class to its original state. |
| SaveViewState() |
A protected method. Saves any state that has been modified after the TrackViewState() method was invoked. (Inherited from Style) |
| SetBit(Int32) |
A protected internal method. Sets an internal bitmask field that indicates the style properties that are stored in the state bag. (Inherited from Style) |
| SetDirty() |
Marks the Style so that its state will be recorded in view state. (Inherited from Style) |
| ToString() |
Returns a string that represents the current object. (Inherited from Style) |
| TrackViewState() |
A protected method. Marks the beginning for tracking state changes on the control. Any changes made after tracking has begun will be tracked and saved as part of the control view state. (Inherited from Style) |
Events
| Disposed |
Occurs when the component is disposed by a call to the Dispose() method. (Inherited from Component) |
