Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

MenuItemStyleCollection Class

.NET Framework 4

Represents a collection of MenuItemStyle objects in a Menu control. This class cannot be inherited.

System.Object
  System.Web.UI.StateManagedCollection
    System.Web.UI.WebControls.MenuItemStyleCollection

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)
C#
C++
F#
VB
Copy 
public sealed class MenuItemStyleCollection : StateManagedCollection

The MenuItemStyleCollection type exposes the following members.

  Name Description
Public property Count Gets the number of elements contained in the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Public property Item Gets the MenuItemStyle object at the specified index from the collection.
Top
  Name Description
Public method Add Appends the specified MenuItemStyle object to the end of the current collection.
Public method Clear Removes all items from the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Public method Contains Determines whether the specified MenuItemStyle object is in the collection.
Public method CopyTo(Array, Int32) Copies the elements of the StateManagedCollection collection to an array, starting at a particular array index. (Inherited from StateManagedCollection.)
Public method CopyTo(MenuItemStyle[], Int32) Copies all the items from the MenuItemStyleCollection object to a compatible one-dimensional array of MenuItemStyle objects, starting at the specified index in the target array.
Protected method CreateKnownType When overridden in a derived class, creates an instance of a class that implements IStateManager. The type of object created is based on the specified member of the collection returned by the GetKnownTypes method. (Inherited from StateManagedCollection.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetEnumerator Returns an iterator that iterates through the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Protected method GetKnownTypes When overridden in a derived class, gets an array of IStateManager types that the StateManagedCollection collection can contain. (Inherited from StateManagedCollection.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IndexOf Determines the index of the specified MenuItemStyle object in the collection.
Public method Insert Inserts the specified MenuItemStyle object into the collection at the specified index location.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnClear When overridden in a derived class, performs additional work before the Clear method removes all items from the collection. (Inherited from StateManagedCollection.)
Protected method OnClearComplete When overridden in a derived class, performs additional work after the Clear method finishes removing all items from the collection. (Inherited from StateManagedCollection.)
Protected method OnInsert When overridden in a derived class, performs additional work before the Insert(Int32, Object) or Add(Object) method adds an item to the collection. (Inherited from StateManagedCollection.)
Protected method OnInsertComplete When overridden in a derived class, performs additional work after the Insert(Int32, Object) or Add(Object) method adds an item to the collection. (Inherited from StateManagedCollection.)
Protected method OnRemove When overridden in a derived class, performs additional work before the Remove(Object) or RemoveAt(Int32) method removes the specified item from the collection. (Inherited from StateManagedCollection.)
Protected method OnRemoveComplete When overridden in a derived class, performs additional work after the Remove(Object) or RemoveAt(Int32) method removes the specified item from the collection. (Inherited from StateManagedCollection.)
Protected method OnValidate When overridden in a derived class, validates an element of the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Public method Remove Removes the specified MenuItemStyle object from the collection.
Public method RemoveAt Removes the MenuItemStyle object at the specified index location from the collection.
Public method SetDirty Forces the entire StateManagedCollection collection to be serialized into view state. (Inherited from StateManagedCollection.)
Protected method SetDirtyObject When overridden in a derived class, instructs an object contained by the collection to record its entire state to view state, rather than recording only change information. (Inherited from StateManagedCollection.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Explicit interface implemetation Private property ICollection.Count Infrastructure. Gets the number of elements contained in the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private property ICollection.IsSynchronized Infrastructure. Gets a value indicating whether the StateManagedCollection collection is synchronized (thread safe). This method returns false in all cases. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private property ICollection.SyncRoot Infrastructure. Gets an object that can be used to synchronize access to the StateManagedCollection collection. This method returns null in all cases. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IEnumerable.GetEnumerator Infrastructure. Returns an iterator that iterates through the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.Add Adds an item to the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.Clear Infrastructure. Removes all items from the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.Contains Determines whether the StateManagedCollection collection contains a specific value. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.IndexOf Determines the index of a specified item in the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.Insert Inserts an item into the StateManagedCollection collection at the specified index. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private property IList.IsFixedSize Infrastructure. Gets a value indicating whether the StateManagedCollection collection has a fixed size. This method returns false in all cases. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private property IList.IsReadOnly Infrastructure. Gets a value indicating whether the StateManagedCollection collection is read-only. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private property IList.Item Infrastructure. Gets the IStateManager element at the specified index. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.Remove Removes the first occurrence of the specified object from the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.RemoveAt Removes the IStateManager element at the specified index. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private property IStateManager.IsTrackingViewState Gets a value indicating whether the StateManagedCollection collection is saving changes to its view state. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IStateManager.LoadViewState Restores the previously saved view state of the StateManagedCollection collection and the IStateManager items it contains. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IStateManager.SaveViewState Saves the changes to the StateManagedCollection collection and each IStateManager object it contains since the time the page was posted back to the server. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IStateManager.TrackViewState Causes the StateManagedCollection collection and each of the IStateManager objects it contains to track changes to their view state so they can be persisted across requests for the same page. (Inherited from StateManagedCollection.)
Top

The MenuItemStyleCollection class is used to store and manage a collection of MenuItemStyle objects in a Menu control. The Menu control uses the MenuItemStyleCollection class as the underlying data type of the LevelMenuItemStyles and LevelSelectedStyles properties.

The LevelMenuItemStyles and LevelSelectedStyles properties are an alternative to the individual style properties (such as StaticMenuItemStyle). These properties are applied to regular menu items and the selected menu item, respectively, based on the menu item's level in the menu. The first style in the collection corresponds to the menu item style for the first level of the menu. The second style in the collection corresponds to the menu item style for the second level of the menu, and so on. The LevelMenuItemStyles and LevelSelectedStyles properties are most often used to generate menus where menu items at a certain level have the same appearance, regardless of whether they have submenus.

The MenuItemStyleCollection class inherits most of its members from the StateManagedCollection class. For more information on the inherited members, see StateManagedCollection.

The following code example demonstrates how to use the MenuItemStyleCollection class to specify the style settings for the menu items in a Menu control based on the menu item's level. In this example, the LevelMenuItemStyles property is created declaratively, and one MenuItemStyle object is removed and another added to the MenuItemStyleCollection object.

C#
VB
Copy 


<%@ Page Language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  void Page_Load(Object sender, EventArgs e)
  {

    if (!IsPostBack)
    {

      // Use the Add and RemoveAt methods to programmatically 
      // remove the third level menu item style and replace 
      // it with a new style, in this case replacing the green background
        // and yellow text with the blue background and white text. 

        MenuItemStyle newStyle = new MenuItemStyle();
        newStyle.BackColor = System.Drawing.Color.Blue;
        newStyle.ForeColor = System.Drawing.Color.White;

        // Remove the last of the three menu item styles. Note that
        // since the collection has a zero-based index, the third
        // entry has an index value of 2.
        MainMenuID.LevelMenuItemStyles.RemoveAt(2);
        MainMenuID.LevelMenuItemStyles.Add(newStyle);

    }

  }

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>MenuItemStyleCollection Example</title>
</head>
<body>
    <form id="form1" runat="server">

      <h3>MenuItemStyleCollection Example</h3>
         <!--Add MenuItemStyle objects to the MenuItemStyleCollection -->
         <!--using LevelMenuItemStyles.  -->
         <!--Note that each menu item style represents a level in the menu -->

      <asp:Menu id="MainMenuID"
       Font-Names= "Arial"
        ForeColor="Blue"
        runat="server">

         <LevelMenuItemStyles>
         <asp:MenuItemStyle BackColor="Azure" 
             Font-Italic="true"
             Font-Names="Arial"
             ForeColor="Black" />

           <asp:MenuItemStyle BackColor="Black" 
             Font-Italic="false"
             Font-Names="Arial"
             ForeColor="White" />

         <asp:MenuItemStyle BackColor="Green" 
             Font-Italic="true"
             Font-Names="Arial"
             ForeColor="Yellow" />

         </LevelMenuItemStyles>

        <items>
          <asp:menuitem text="Home"
            tooltip="Home">
            <asp:menuitem text="Music"
              tooltip="Music">
              <asp:menuitem text="Classical"
                tooltip="Classical"/>
              <asp:menuitem text="Rock"
                tooltip="Rock"/>
              <asp:menuitem text="Jazz"
                tooltip="Jazz"/>
            </asp:menuitem>
            <asp:menuitem text="Movies"
              tooltip="Movies">
              <asp:menuitem text="Action"
                tooltip="Action"/>
              <asp:menuitem text="Drama"
                tooltip="Drama"/>
              <asp:menuitem text="Musical"
                tooltip="Musical"/>
            </asp:menuitem>
          </asp:menuitem>
        </items>


      </asp:Menu>

    </form>
  </body>
</html>

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ