ComponentToolCollection

Wisej.Web.ComponentToolCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Represents a set of tool widgets associated with a component. The component includes the tools panel according to its design. For example, the Form component includes the tools in its caption bar. Other components may include the tools elsewhere.

C#

public class ComponentToolCollection : IList, ICollection, IEnumerable, IList<ComponentTool>, ICollection<ComponentTool>, IEnumerable<ComponentTool>

VB.NET

Public Class ComponentToolCollection
    Inherits IList
    Implements ICollection, IEnumerable, IList(Of ComponentTool), ICollection(Of ComponentTool), IEnumerable(Of ComponentTool)

Constructors

ComponentToolCollection()

Initializes a new instance of the ComponentToolCollection class not bound to any control.

ComponentToolCollection(owner)

Initializes a new instance of the ComponentToolCollection class.

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

Properties

IsReadOnly

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

Item(index)

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

Item(name)

ComponentTool: Returns the ComponentTool identified by the name.

Methods

Add(name, imageSource)

Adds a ComponentTool with the specified name and image source to the collection.

Parameter	Type	Description
name	String	The name of the ComponentTool that is being added.
imageSource	String	The image of the ComponentTool that is being added.

Returns: ComponentTool. A ComponentTool that represents the panel that was added to the collection.

Add(tool)

Adds a ComponentTool to the collection.

Parameter	Type	Description
tool	ComponentTool	A ComponentTool that represents the panel to add to the collection.

Throws:

• ArgumentNullException The ComponentTool being added to the collection was null.

• ArgumentException The parent of the ComponentTool specified in the tool parameter is not null.

AddRange(tools)

Adds an array of ComponentTool to the collection

Parameter	Type	Description
tools	ComponentTool[]

Clear()

Removes all tools from the collection.

Clear(dispose)

Removes and optionally disposes all tools from the collection.

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

Contains(tool)

Determines whether the specified panel is located within the collection.

Parameter	Type	Description
tool	ComponentTool	The ComponentTool to locate in the collection.

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

ContainsKey(key)

Determines whether the collection contains a ComponentTool 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 ComponentTool with the specified key; otherwise, false.

GetEnumerator()

Returns an enumerator to use to iterate through the item collection.

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

IndexOf(tool)

Returns the index within the collection of the specified panel.

Parameter	Type	Description
tool	ComponentTool	The ComponentTool to locate in the collection.

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

IndexOfKey(key)

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

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

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

Insert(index, tool)

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

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

Throws:

• ArgumentNullException The tool parameter is null.

• ArgumentException The tool 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 ComponentToolCollection class.

Remove(tool)

Removes the specified ComponentTool from the collection.

Parameter	Type	Description
tool	ComponentTool	The ComponentTool representing the panel to remove from the collection.

Returns: Boolean.

Throws:

• ArgumentNullException The ComponentTool assigned to the tool parameter is null.

RemoveAt(index)

Removes the ComponentTool 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 ComponentToolCollection class.

RemoveByKey(key)

Removes the ComponentTool with the specified key from the collection.

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