MenuItemStyle Class

.NET Framework (current version)

Represents the style of a menu item in a Menu control. This class cannot be inherited.

Namespace: System.Web.UI.WebControls
Assembly: System.Web (in System.Web.dll)

Inheritance Hierarchy

System::Object
System::MarshalByRefObject
System.ComponentModel::Component
System.Web.UI.WebControls::Style
System.Web.UI.WebControls::MenuItemStyle

Syntax

C++

public ref class MenuItemStyle sealed : Style

Constructors

	Name	Description
	MenuItemStyle()	Initializes a new instance of the MenuItemStyle class.
	MenuItemStyle(StateBag^)	Initializes a new instance of the MenuItemStyle class using the specified state information.

Properties

	Name	Description
	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.)
	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.)
	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 the menu item's text.
	IsEmpty	This API supports the product infrastructure and is not intended to be used directly from your code. A protected property. Gets a value indicating whether any style elements have been defined in the state bag.(Inherited from Style.)
	ItemSpacing	Gets or sets the amount of vertical spacing between the menu item to which the MenuItemStyle object is applied and its adjacent menu items.
	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 menu item's text.
	ViewState	This API supports the product infrastructure and is not intended to be used directly from your code. 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

	Name	Description
	AddAttributesToRender(HtmlTextWriter^)	Adds HTML attributes and styles that need to be rendered to the specified System.Web.UI::HtmlTextWriter. This method is primarily used by control developers.(Inherited from Style.)
	AddAttributesToRender(HtmlTextWriter^, WebControl^)	Adds HTML attributes and styles that need to be rendered to the specified System.Web.UI::HtmlTextWriter and Web server control. 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 MenuItemStyle class.(Overrides Style::CopyFrom(Style^).)
	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.)
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetLifetimeService()	Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)
	GetStyleAttributes(IUrlResolutionService^)	Retrieves the System.Web.UI::CssStyleCollection object for the specified System.Web.UI::IUrlResolutionService-implemented object.(Inherited from Style.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	InitializeLifetimeService()	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.)
	MergeWith(Style^)	Combines the style properties of the specified Style object with those of the current instance of the MenuItemStyle class.(Overrides Style::MergeWith(Style^).)
	Reset()	Returns the current instance of the MenuItemStyle class to its original state.(Overrides Style::Reset().)
	SaveViewState()	A protected method. Saves any state that has been modified after the TrackViewState method was invoked.(Inherited from Style.)
	SetBit(Int32)	This API supports the product infrastructure and is not intended to be used directly from your code. 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 containing the name of the Component, if any. This method should not be overridden.(Inherited from Component.)
	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

	Name	Description
	Disposed	Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

Explicit Interface Implementations

	Name	Description
	IStateManager::LoadViewState(Object^)	This API supports the product infrastructure and is not intended to be used directly from your code. Loads the previously saved state.(Inherited from Style.)
	IStateManager::SaveViewState()	This API supports the product infrastructure and is not intended to be used directly from your code. Returns the object containing state changes.(Inherited from Style.)
	IStateManager::TrackViewState()	This API supports the product infrastructure and is not intended to be used directly from your code. Starts tracking state changes.(Inherited from Style.)
	IStateManager::IsTrackingViewState	Gets a value that indicates whether a server control is tracking its view state changes.(Inherited from Style.)

Use the MenuItemStyle class to represent the style of a menu item in the Menu control. A menu item is displayed in either a static menu or a dynamic menu. A static menu is always displayed in 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 each of the different menu item types. The following table lists the available menu item styles.

Menu item style property	Description
DynamicHoverStyle	The style settings for a dynamic menu item when the mouse pointer is positioned over it.
DynamicMenuItemStyle	The style settings for an individual dynamic menu item.
DynamicMenuStyle	The style settings for a dynamic menu.
DynamicSelectedStyle	The style settings for the currently selected dynamic menu item.
StaticHoverStyle	The style settings for a static menu item when the mouse pointer is positioned over it.
StaticMenuItemStyle	The style settings for an individual static menu item.
StaticMenuStyle	The style settings for a static menu.
StaticSelectedStyle	The style settings for the currently selected static menu item.

When multiple style properties are set for a static menu item, the style properties are applied in the following order:

StaticMenuStyle.
StaticMenuItemStyle. If the LevelMenuItemStyles collection or LevelSubMenuStyles collection is defined, it is applied at this time, overriding the other menu item style properties.
StaticSelectedStyle. If the LevelSelectedStyles collection is defined, it is applied at this time, overriding the other menu item style properties.
StaticHoverStyle.

Likewise, the style properties for a dynamic menu item are applied in the following order:

DynamicMenuStyle.
DynamicMenuItemStyle. If the LevelMenuItemStyles collection or LevelSubMenuStyles collection is defined, it is applied at this time, overriding the other menu item style properties.
DynamicSelectedStyle. If the LevelSelectedStyles collection is defined, it is applied at this time, overriding the other menu item style properties.
DynamicHoverStyle.

The MenuItemStyle 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, as well as the space between adjacent menu items. 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. You can control the amount of spacing between the menu item that the MenuItemStyle object is applied to and its adjacent menu items by setting the ItemSpacing property.

For more information on the inherited style settings, see Style.

Examples

The following code example demonstrates how to control the appearance of the menu items in a Menu control by setting the style properties of the MenuItemStyle object returned from the DynamicMenuItemStyle, DynamicHoverStyle, StaticMenuItemStyle, and StaticHoverStyle properties.

C++

No code example is currently available or this language may not be supported.

Version Information

.NET Framework
Available since 2.0

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.