ToolBar.ToolBarButtonCollection

Wisej.Web.ToolBar ToolBarButtonCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represents the collection of ToolBarButton controls in a ToolBar control.

C#

public class ToolBarButtonCollection : IList, ICollection, IEnumerable, IList<ToolBarButton>, ICollection<ToolBarButton>, IEnumerable<ToolBarButton>

VB.NET

Public Class ToolBarButtonCollection
    Inherits IList
    Implements ICollection, IEnumerable, IList(Of ToolBarButton), ICollection(Of ToolBarButton), IEnumerable(Of ToolBarButton)

Constructors

ToolBarButtonCollection(owner)

Initializes a new instance of the ToolBarButtonCollection class.

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

Properties

IsDirty

Boolean: Returns or sets the dirty state for the list. When true, the list of items must be sent back to the client.

IsNew

Boolean: Returns or sets the new state for the list. When true, the entire list is cleared and reloaded on the client.

IsReadOnly

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

Item(index)

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

Item(name)

ToolBarButton: Returns the ToolBarButton identified by the name.

Methods

Add(text)

Adds a ToolBarButton with the specified text to the collection.

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

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

Add(button)

Adds a ToolBarButton to the collection.

Parameter	Type	Description
button	ToolBarButton	A ToolBarButton that represents the panel to add to the collection.

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

Throws:

• ArgumentNullException The ToolBarButton being added to the collection is null.

• ArgumentException The parent of the ToolBarButton specified in the button parameter is not null.

AddRange(buttons)

Adds an array of ToolBarButton to the collection.

Parameter	Type	Description
buttons	ToolBarButton[]	Array of ToolBarButton objects to add to the collection.

Clear()

Removes all ToolBarButton objects from the collection.

Clear(dispose)

Removes and optionally disposes all ToolBarButton objects from the collection.

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

Contains(button)

Determines whether the specified ToolBarButton is located within the collection.

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

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

ContainsKey(key)

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

GetEnumerator()

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

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

IndexOf(button)

Returns the index within the collection of the specified ToolBarButton.

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

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

IndexOfKey(key)

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

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

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

Insert(index, button)

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

Parameter	Type	Description
index	Int32	The zero-based index location where the panel is inserted.
button	ToolBarButton	A ToolBarButton 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 ToolBarButtonCollection class.

Remove(button)

Removes the specified ToolBarButton from the collection.

Parameter	Type	Description
button	ToolBarButton	The ToolBarButton representing the panel to remove from the collection.

Throws:

• ArgumentNullException The ToolBarButton assigned to the button parameter is null.

RemoveAt(index)

Removes the ToolBarButton 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 ToolBarButtonCollection class.

RemoveByKey(key)

Removes the ToolBarButton with the specified key from the collection.

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

Render()

Renders the list to the json definition for the client.

Returns: Object.