MenuItemCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

Represents a collection of MenuItem objects.

C#

public class MenuItemCollection : IList, ICollection, IEnumerable, IList<MenuItem>, ICollection<MenuItem>, IEnumerable<MenuItem>

VB.NET

Public Class MenuItemCollection
    Inherits IList
    Implements ICollection, IEnumerable, IList(Of MenuItem), ICollection(Of MenuItem), IEnumerable(Of MenuItem)

Constructors

MenuItemCollection(owner)

Initializes a new instance of MenuItemCollection.

Name	Type	Description
owner	Menu	The Menu object that owns the collection.

Properties

Count

Int32: Returns the number of items in the collection.

IsReadOnly

Boolean: Returns a value indicating whether this collection can be modified.

Item(index)

MenuItem: Retrieves the item at the specified index within the collection.

Throws:

• ArgumentOutOfRangeException The index was less than zero; or the index was greater of equal to the count of items in the collection.

Item(key)

MenuItem: Retrieves the item at the specified index within the collection.

Methods

Add(caption)

Adds an item to the list of items.

Parameter	Type	Description
caption	String	The text of the new menu item.

Returns: MenuItem.

Add(caption, onClick)

Adds an item to the list of items.

Parameter	Type	Description
caption	String	The text of the new menu item.
onClick	EventHandler	An event handler for the click event.

Returns: MenuItem.

Add(caption, items)

Adds an item to the list of items.

Parameter	Type	Description
caption	String	The text of the new menu item.
items	MenuItem[]	List of child menu items.

Returns: MenuItem.

Add(item)

Adds an item to the list of items.

Parameter	Type	Description
item	MenuItem	The new menu item.

Returns: Int32.

Add(index, item)

Adds an item to the list of items.

Parameter	Type	Description
index	Int32	The index where to add/insert the new menu item.
item	MenuItem	The MenuItem to add to the collection

Returns: Int32.

AddRange(items)

Adds a collection of items to the list.

Parameter	Type	Description
items	MenuItem[]

Clear()

Removes all items from the Menu.

Clear(dispose)

Removes and disposes all items from the Menu.

Parameter	Type	Description
dispose	Boolean	Indicates whether the removed items should be disposed.

Contains(value)

Determines if the specified item is located within the collection.

Parameter	Type	Description
value	MenuItem	An object representing the item to locate in the collection.

Returns: Boolean. true if the item is located within the collection; otherwise, false.

ContainsKey(key)

Determines if the specified item is located within the collection.

Parameter	Type	Description
key	String	The key of the item to locate.

Returns: Boolean. true if the item is located within the collection; otherwise, false.

CopyTo(dest, index)

Copies the entire collection into an existing array of objects at a specified location within the array.

Parameter	Type	Description
dest	Array	The object array to copy the collection to.
index	Int32	The location in the destination array to copy the collection to.

Find(key, searchAllChildren)

Finds all the items with a specific key.

Parameter	Type	Description
key	String	The key of the item to locate.
searchAllChildren	Boolean	Indicates that the search should include child items.

Returns: MenuItem[].

GetEnumerator()

Returns an enumerator that can be used to iterate through the item collection.

Returns: IEnumerator. A IEnumerator that represents the item collection.

IndexOf(value)

Retrieves the index within the collection of the specified item.

Parameter	Type	Description
value	MenuItem	The menu item to locate.

Returns: Int32. The zero-based index where the item is located within the collection; otherwise, -1.

Throws:

• ArgumentNullException The value parameter was null.

IndexOfKey(key)

Retrieves the index within the collection of the specified item.

Parameter	Type	Description
key	String	The key for the menu item to locate.

Returns: Int32. The zero-based index where the item is located within the collection; otherwise, -1.

Remove(item)

Removes the specified item from the list.

Parameter	Type	Description
item	MenuItem	The item to remove.

RemoveAt(index)

Removes an item at the specified index.

Parameter	Type	Description
index	Int32	The index of the item to remove.

Throws:

• ArgumentOutOfRangeException The index parameter was less than zero, or the index parameter was greater than or equal to the count of items in the collection.

RemoveByKey(key)

Removes the item with the specified key.

Parameter	Type	Description
key	String	The key of the menu item to remove.