StatusBar.StatusBarPanelCollection

Wisej.Web.StatusBar StatusBarPanelCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represents the collection of StatusBarPanel controls in a StatusBar control.

C#

public class StatusBarPanelCollection : IList, ICollection, IEnumerable, IList<StatusBarPanel>, ICollection<StatusBarPanel>, IEnumerable<StatusBarPanel>

VB.NET

Public Class StatusBarPanelCollection
    Inherits IList
    Implements ICollection, IEnumerable, IList(Of StatusBarPanel), ICollection(Of StatusBarPanel), IEnumerable(Of StatusBarPanel)

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)

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

Item(name)

StatusBarPanel: Returns the StatusBarPanel identified by the name.

Methods

Add(text)

Adds a StatusBarPanel with the specified text to the collection.

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

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

Add(panel)

Adds a StatusBarPanel to the collection.

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

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

Throws:

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

• ArgumentException The parent of the StatusBarPanel specified in the panel parameter is not null.

AddRange(panels)

Adds an array of StatusBarPanel to the collection.

Parameter	Type	Description
panels	StatusBarPanel[]	Array of StatusBarPanel objects to add to the collection.

Clear()

Removes all panels from the collection.

Clear(dispose)

Removes and optionally disposes all StatusBarPanel objects from the collection.

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

Contains(panel)

Determines whether the specified StatusBarPanel is located within the collection.

Parameter	Type	Description
panel	StatusBarPanel	The StatusBarPanel to locate in the collection.

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

ContainsKey(key)

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

GetEnumerator()

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

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

IndexOf(panel)

Returns the index within the collection of the specified StatusBarPanel.

Parameter	Type	Description
panel	StatusBarPanel	The StatusBarPanel to locate in the collection.

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

IndexOfKey(key)

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

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

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

Insert(index, panel)

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

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

Throws:

• ArgumentNullException The panel parameter is null.

• ArgumentException The panel 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 StatusBarPanelCollection class.

Remove(panel)

Removes the specified StatusBarPanel from the collection.

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

Throws:

• ArgumentNullException The StatusBarPanel assigned to the panel parameter is null.

RemoveAt(index)

Removes the StatusBarPanel 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 StatusBarPanelCollection class.

RemoveByKey(key)

Removes the StatusBarPanel with the specified key from the collection.

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

Render()

Renders the list to the json definition for the client.

Returns: Object.