DesktopTaskBarItemCollection

Wisej.Web.DesktopTaskBarItemCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the collection of DesktopTaskBarItem controls in a Desktop control.

C#

public class DesktopTaskBarItemCollection : IList, ICollection, IEnumerable

VB.NET

Public Class DesktopTaskBarItemCollection
    Inherits IList
    Implements ICollection, IEnumerable

Constructors

DesktopTaskBarItemCollection(owner)

Initializes a new instance of the DesktopTaskBarItemCollection class.

Name	Type	Description
owner	Desktop	The Desktop control that owns this collection.

Properties

IsReadOnly

Boolean: Returns a value indicating whether this collection is read-only.

Item(index)

DesktopTaskBarItem: Returns or sets the DesktopTaskBarItem at the specified index.

Item(name)

DesktopTaskBarItem: Returns the DesktopTaskBarItem identified by the name.

Methods

Add(text)

Adds a DesktopTaskBarItem with the specified text to the collection.

Parameter	Type	Description
text	String	The text for the DesktopTaskBarItem that is being added.

Returns: DesktopTaskBarItem. A DesktopTaskBarItem that represents the item that was added to the collection.

Add(item)

Adds a DesktopTaskBarItem to the collection.

Parameter	Type	Description
item	DesktopTaskBarItem	A DesktopTaskBarItem that represents the panel to add to the collection.

Returns: Int32. The zero-based index of the item in the collection.

Throws:

• ArgumentNullException The DesktopTaskBarItem being added to the collection is null.
• ArgumentException The parent of the DesktopTaskBarItem specified in the item parameter is not null.

AddRange(items)

Adds an array of DesktopTaskBarItem to the collection.

Parameter	Type	Description
items	DesktopTaskBarItem[]	Array of DesktopTaskBarItem objects to add to the collection.

Clear()

Removes all DesktopTaskBarItem objects from the collection.

Clear(dispose)

Removes and optionally disposes all DesktopTaskBarItem objects from the collection.

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

Contains(button)

Determines whether the specified DesktopTaskBarItem is located within the collection.

Parameter	Type	Description
button	DesktopTaskBarItem	The DesktopTaskBarItem to locate in the collection.

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

ContainsKey(key)

Determines whether the collection contains a DesktopTaskBarItem with the specified key.

Parameter	Type	Description
key	String	The name of the item to find in the collection.

Returns: Boolean. true to indicate the collection contains a DesktopTaskBarItem with the specified key; otherwise, false.

GetEnumerator()

Returns an enumerator to use to iterate through the DesktopTaskBarItem objects in the collection.

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

IndexOf(button)

Returns the index within the collection of the specified DesktopTaskBarItem.

Parameter	Type	Description
button	DesktopTaskBarItem	The DesktopTaskBarItem to locate in the collection.

Returns: Int32. The zero-based index where the DesktopTaskBarItem is located within the collection; otherwise, negative one (-1).

IndexOfKey(key)

Returns the index of the first occurrence of a DesktopTaskBarItem with the specified key.

Parameter	Type	Description
key	String	The name of the DesktopTaskBarItem to find in the collection.

Returns: Int32. The zero-based index of the first occurrence of the DesktopTaskBarItem with the specified key, if found; otherwise, -1.

Insert(index, button)

Inserts the specified DesktopTaskBarItem into the collection at the specified index.

Parameter	Type	Description
index	Int32	The zero-based index location where the panel is inserted.
button	DesktopTaskBarItem	A DesktopTaskBarItem representing the panel to insert.

Throws:

• ArgumentNullException The button parameter is null.
• ArgumentException The button parameter's parent is not null.
• ArgumentOutOfRangeException The index parameter is less than zero or greater than the value of the Count property of the DesktopTaskBarItemCollection class.

Remove(item)

Removes the specified DesktopTaskBarItem from the collection.

Parameter	Type	Description
item	DesktopTaskBarItem	The DesktopTaskBarItem representing the panel to remove from the collection.

Throws:

• ArgumentNullException The DesktopTaskBarItem assigned to the item parameter is null.

RemoveAt(index)

Removes the DesktopTaskBarItem located at the specified index within the collection.

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

Throws:

• ArgumentOutOfRangeException The index parameter is less than zero or greater than or equal to the value of the Count property of the DesktopTaskBarItemCollection class.

RemoveByKey(key)

Removes the DesktopTaskBarItem with the specified key from the collection.

Parameter	Type	Description
key	String	The name of the DesktopTaskBarItem to remove from the collection.