MenuItemBindingCollection Class

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

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 a collection of MenuItemBinding objects.

public ref class MenuItemBindingCollection sealed : System::Web::UI::StateManagedCollection

public sealed class MenuItemBindingCollection : System.Web.UI.StateManagedCollection

type MenuItemBindingCollection = class
    inherit StateManagedCollection

Public NotInheritable Class MenuItemBindingCollection
Inherits StateManagedCollection

Inheritance: Object

StateManagedCollection
MenuItemBindingCollection

Examples

The following code example demonstrates how to populate a MenuItemBindingCollection object declaratively. For this example to work correctly, you must copy the sample XML data below to a file named Map.xml.


<%@ 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 DataBindings Example</title>
</head>
<body>
    <form id="form1" runat="server">
    
      <h3>Menu DataBindings Example</h3>
    
      <asp:menu id="NavigationMenu"
        staticdisplaylevels="1"
        staticsubmenuindent="10" 
        orientation="Vertical"
        target="_blank"
        datasourceid="MenuSource"
        runat="server">
        
       <DataBindings>
        
          <asp:menuitembinding datamember="MapHomeNode" 
            depth="0"
            textfield="title" 
            navigateurlfield="url"/>
          <asp:menuitembinding datamember="MapNode" 
            depth="1"
            textfield="title" 
            navigateurlfield="url"/>
          <asp:menuitembinding datamember="MapNode" 
            depth="2"
            textfield="title" 
            navigateurlfield="url"/>
        </DataBindings>
        
      </asp:menu>
      
      <asp:XmlDataSource id="MenuSource"
        datafile="Map.xml"
        runat="server"/>        

    </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 DataBindings Example</title>
</head>
<body>
    <form id="form1" runat="server">
    
      <h3>Menu DataBindings Example</h3>
    
      <asp:menu id="NavigationMenu"
        staticdisplaylevels="1"
        staticsubmenuindent="10" 
        orientation="Vertical"
        target="_blank"
        datasourceid="MenuSource"
        runat="server">
        
        <DataBindings>
          <asp:menuitembinding datamember="MapHomeNode" 
            depth="0"
            textfield="title" 
            navigateurlfield="url"/>
          <asp:menuitembinding datamember="MapNode" 
            depth="1"
            textfield="title" 
            navigateurlfield="url"/>
          <asp:menuitembinding datamember="MapNode" 
            depth="2"
            textfield="title" 
            navigateurlfield="url"/>
        </DataBindings>
        
      </asp:menu>
      
      <asp:XmlDataSource id="MenuSource"
        datafile="Map.xml"
        runat="server"/>        

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

The following code example demonstrates how to add MenuItemBinding objects to a MenuItemBindingCollection object programmatically. For this example to work correctly, you must copy the sample XML data below to a file named Map.xml.


<%@ 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)
    {
      // Create the menu item bindings for the Menu control.
      MenuItemBinding binding;
      
      binding = CreateMenuItemBinding("MapHomeNode", 0, "title", "url");
      NavigationMenu.DataBindings.Add(binding);

      binding = CreateMenuItemBinding("MapNode", 1, "title", "url");
      NavigationMenu.DataBindings.Add(binding);

      binding = CreateMenuItemBinding("MapNode", 2, "title", "url");
      NavigationMenu.DataBindings.Add(binding);
    }
  }

  // This is a helper method to create a MenuItemBinding 
  // object from the specified parameters.
  MenuItemBinding CreateMenuItemBinding(String dataMember, int depth, String textField, String navigateUrlField)
  {
    // Create a new MenuItemBinding object.
    MenuItemBinding binding = new MenuItemBinding();

    // Set the properties of the MenuItemBinding object.
    binding.DataMember = dataMember;
    binding.Depth = depth;
    binding.TextField = textField;
    binding.NavigateUrlField = navigateUrlField;

    return binding;
  }
    
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>MenuItemBindingCollection Add Example</title>
</head>
<body>
    <form id="form1" runat="server">
    
      <h3>MenuItemBindingCollection Add Example</h3>
    
      <asp:menu id="NavigationMenu"
        staticdisplaylevels="2"
        staticsubmenuindent="10" 
        orientation="Vertical"
        target="_blank"
        datasourceid="MenuSource"
        runat="server">        
      </asp:menu>
      
      <asp:xmldatasource id="MenuSource"
        datafile="Map.xml"
        runat="server"/>        

    </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">
<script runat="server">

  Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
 
    If Not IsPostBack Then
    
      ' Create the menu item bindings for the Menu control.
      Dim binding As MenuItemBinding
      
      binding = CreateMenuItemBinding("MapHomeNode", 0, "title", "url")
      NavigationMenu.DataBindings.Add(binding)

      binding = CreateMenuItemBinding("MapNode", 1, "title", "url")
      NavigationMenu.DataBindings.Add(binding)

      binding = CreateMenuItemBinding("MapNode", 2, "title", "url")
      NavigationMenu.DataBindings.Add(binding)
   
    End If
    
  End Sub

  ' This is a helper method to create a MenuItemBinding 
  ' object from the specified parameters.
  Function CreateMenuItemBinding(ByVal dataMember As String, ByVal depth As Integer, ByVal textField As String, ByVal navigateUrlField As String) As MenuItemBinding
  
    ' Create a new MenuItemBinding object.
    Dim binding As New MenuItemBinding()

    ' Set the properties of the MenuItemBinding object.
    binding.DataMember = dataMember
    binding.Depth = depth
    binding.TextField = textField
    binding.NavigateUrlField = navigateUrlField

    Return binding
    
  End Function
    
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>MenuItemBindingCollection Add Example</title>
</head>
<body>
    <form id="form1" runat="server">
    
      <h3>MenuItemBindingCollection Add Example</h3>
    
      <asp:menu id="NavigationMenu"
        staticdisplaylevels="2"
        staticsubmenuindent="10" 
        orientation="Vertical"
        target="_blank"
        datasourceid="MenuSource"
        runat="server">        
      </asp:menu>
      
      <asp:xmldatasource id="MenuSource"
        datafile="Map.xml"
        runat="server"/>        

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

The following is sample site map data for the previous examples.

<MapHomeNode url="~\Home.aspx"

title="Home"

description="Home">

<MapNode url="~\Music.aspx"

title="Music"

description="Music">

<MapNode url="~\Classical.aspx"

title="Classical"

description="Classical"/>

<MapNode url="~\Rock.aspx"

title="Rock"

description="Rock"/>

<MapNode url="~\Jazz.aspx"

title="Jazz"

description="Jazz"/>

</MapNode>

<MapNode url="~\Movies.aspx"

title="Movies"

description="Movies">

<MapNode url="~\Action.aspx"

title="Action"

description="Action"/>

<MapNode url="~\Drama.aspx"

title="Drama"

description="Drama"/>

<MapNode url="~\Musical.aspx"

title="Musical"

description="Musical"/>

</MapNode>

</MapHomeNode>

Remarks

The MenuItemBindingCollection class is used to store and manage a collection of MenuItemBinding objects in the Menu control. The Menu control uses the MenuItemBindingCollection class as the data type for its DataBindings property. The DataBindings property is used to store any menu item bindings defined for the Menu control.

Note

The order in which MenuItemBinding objects appear in the collection has no effect on how those objects are applied to the menu items in a Menu control.

The MenuItemBindingCollection class supports several ways to access the items in the collection:

Use the Item[] indexer to directly retrieve the MenuItemBinding object at a specific zero-based index.
Use the GetEnumerator method to create an enumerator that can be used to iterate through the collection.
Use the CopyTo method to copy the contents of the collection into an array.

You can programmatically manage a MenuItemBindingCollection object by adding and removing MenuItemBinding objects. To add menu items to the collection, use the Add or the Insert method. To remove nodes from the collection, use the Remove, the RemoveAt, or the Clear method.

The MenuItemBindingCollection class contains properties and methods that allow you to retrieve information about the collection itself. To find out how many items are in the collection, use the Count property. If you want to determine whether the collection contains a certain MenuItemBinding object, use the Contains method. To get the index of a MenuItemBinding object in the collection, use the IndexOf method.

Properties

Count	Gets the number of elements contained in the StateManagedCollection collection. (Inherited from StateManagedCollection)
Item[Int32]	Gets the MenuItemBinding object at the specified index from the collection.

Methods

Add(MenuItemBinding)	Appends the specified MenuItemBinding object to the end of the collection.
Clear()	Removes all items from the StateManagedCollection collection. (Inherited from StateManagedCollection)
Contains(MenuItemBinding)	Determines whether the specified MenuItemBinding object is in the collection.
CopyTo(Array, Int32)	Copies the elements of the StateManagedCollection collection to an array, starting at a particular array index. (Inherited from StateManagedCollection)
CopyTo(MenuItemBinding[], Int32)	Copies all the items from the MenuItemBindingCollection object to a compatible one-dimensional array of MenuItemBinding objects, starting at the specified index in the target array.
CreateKnownType(Int32)	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)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetEnumerator()	Returns an iterator that iterates through the StateManagedCollection collection. (Inherited from StateManagedCollection)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetKnownTypes()	When overridden in a derived class, gets an array of IStateManager types that the StateManagedCollection collection can contain. (Inherited from StateManagedCollection)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IndexOf(MenuItemBinding)	Determines the index of the specified MenuItemBinding object in the collection.
Insert(Int32, MenuItemBinding)	Adds the specified MenuItemBinding object to the collection at the specified index location.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnClear()	When overridden in a derived class, performs additional work before the Clear() method removes all items from the collection. (Inherited from StateManagedCollection)
OnClearComplete()	When overridden in a derived class, performs additional work after the Clear() method finishes removing all items from the collection. (Inherited from StateManagedCollection)
OnInsert(Int32, Object)	When overridden in a derived class, performs additional work before the IList.Insert(Int32, Object) or IList.Add(Object) method adds an item to the collection. (Inherited from StateManagedCollection)
OnInsertComplete(Int32, Object)	When overridden in a derived class, performs additional work after the IList.Insert(Int32, Object) or IList.Add(Object) method adds an item to the collection. (Inherited from StateManagedCollection)
OnRemove(Int32, Object)	When overridden in a derived class, performs additional work before the IList.Remove(Object) or IList.RemoveAt(Int32) method removes the specified item from the collection. (Inherited from StateManagedCollection)
OnRemoveComplete(Int32, Object)	When overridden in a derived class, performs additional work after the IList.Remove(Object) or IList.RemoveAt(Int32) method removes the specified item from the collection. (Inherited from StateManagedCollection)
OnValidate(Object)	When overridden in a derived class, validates an element of the StateManagedCollection collection. (Inherited from StateManagedCollection)
Remove(MenuItemBinding)	Removes the specified MenuItemBinding object from the collection.
RemoveAt(Int32)	Removes the MenuItemBinding object at the specified index location from the collection.
SetDirty()	Forces the entire StateManagedCollection collection to be serialized into view state. (Inherited from StateManagedCollection)
SetDirtyObject(Object)	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)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

ICollection.Count	Gets the number of elements contained in the StateManagedCollection collection. (Inherited from StateManagedCollection)
ICollection.IsSynchronized	Gets a value indicating whether the StateManagedCollection collection is synchronized (thread safe). This method returns `false` in all cases. (Inherited from StateManagedCollection)
ICollection.SyncRoot	Gets an object that can be used to synchronize access to the StateManagedCollection collection. This method returns `null` in all cases. (Inherited from StateManagedCollection)
IEnumerable.GetEnumerator()	Returns an iterator that iterates through the StateManagedCollection collection. (Inherited from StateManagedCollection)
IList.Add(Object)	Adds an item to the StateManagedCollection collection. (Inherited from StateManagedCollection)
IList.Clear()	Removes all items from the StateManagedCollection collection. (Inherited from StateManagedCollection)
IList.Contains(Object)	Determines whether the StateManagedCollection collection contains a specific value. (Inherited from StateManagedCollection)
IList.IndexOf(Object)	Determines the index of a specified item in the StateManagedCollection collection. (Inherited from StateManagedCollection)
IList.Insert(Int32, Object)	Inserts an item into the StateManagedCollection collection at the specified index. (Inherited from StateManagedCollection)
IList.IsFixedSize	Gets a value indicating whether the StateManagedCollection collection has a fixed size. This method returns `false` in all cases. (Inherited from StateManagedCollection)
IList.IsReadOnly	Gets a value indicating whether the StateManagedCollection collection is read-only. (Inherited from StateManagedCollection)
IList.Item[Int32]	Gets the IStateManager element at the specified index. (Inherited from StateManagedCollection)
IList.Remove(Object)	Removes the first occurrence of the specified object from the StateManagedCollection collection. (Inherited from StateManagedCollection)
IList.RemoveAt(Int32)	Removes the IStateManager element at the specified index. (Inherited from StateManagedCollection)
IStateManager.IsTrackingViewState	Gets a value indicating whether the StateManagedCollection collection is saving changes to its view state. (Inherited from StateManagedCollection)
IStateManager.LoadViewState(Object)	Restores the previously saved view state of the StateManagedCollection collection and the IStateManager items it contains. (Inherited from StateManagedCollection)
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)
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)

Extension Methods

Cast<TResult>(IEnumerable)	Casts the elements of an IEnumerable to the specified type.
OfType<TResult>(IEnumerable)	Filters the elements of an IEnumerable based on a specified type.
AsParallel(IEnumerable)	Enables parallelization of a query.
AsQueryable(IEnumerable)	Converts an IEnumerable to an IQueryable.

Applies to

Jaa