ComboBox.ObjectCollection

Wisej.Web.ComboBox ObjectCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represents the collection of items in a Wisej.Web.ComboBox control.

C#

public class ObjectCollection : IList, ICollection, IEnumerable

VB.NET

Public Class ObjectCollection
    Inherits IList
    Implements ICollection, IEnumerable

Properties

Count

Int32: Returns the number of items in the collection.

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 can be modified.

Item(index)

Object: 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.

Methods

Add(item)

Adds an item to the list of items for a ComboBox.

Parameter	Type	Description
item	Object	An object representing the item to add to the collection.

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

Throws:

• ArgumentNullException The item parameter was null.

AddRange(items)

Adds a collection of items to the list.

Parameter	Type	Description
items	Object[]	Collection of items to add to the list.

Clear()

Removes all items from the ComboBox.

ClearInternal()

Removes all the items from the list without checking for the data source binding.

Contains(value)

Determines if the specified item is located within the collection.

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

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

Throws:

• ArgumentNullException value is null.

CopyTo(destination, index)

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

Parameter	Type	Description
destination	Object[]	The object array to copy the collection to.
index	Int32	The location in the destination array to copy the collection to.

CreateItemElement(value, state)

Returns an instance of the Element wrapper class.

Parameter	Type	Description
value	Object	Wrapped value.
state	ElementState	Initial state.

Returns: Element.

FillItems(items)

Adds a collection of items to the list.

Parameter	Type	Description
items	IList	Collection of items to add to the list.

GetEnumerator()

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

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

GetItem(index)

Returns the element at the index.

Parameter	Type	Description
index	Int32

Returns: Element.

GetRealIndex(index)

Returns the real index in the collection accounting for the deleted items that have not been committed to the client yet.

Parameter	Type	Description
index	Int32

Returns: Int32.

IndexOf(value)

Retrieves the index within the collection of the specified item.

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

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

Throws:

• ArgumentNullException The value parameter was null.

IndexOf(element)

Retrieves the index within the collection of the specified item.

Parameter	Type	Description
element	Element	An object representing the item to locate in the collection.

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

Throws:

• ArgumentNullException The element parameter was null.

Insert(index, item)

Inserts an item into the collection at the specified index.

Parameter	Type	Description
index	Int32	The zero-based index location where the item is inserted.
item	Object	An object representing the item to insert.

Throws:

• ArgumentNullException The item was null.

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

OnCollectionChanged(action, element)

Fires the CollectionChanged event.

Parameter	Type	Description
action	CollectionChangeAction	One of CollectionChangeAction indicating the reason the collection has changed.
element	Object	The element that was added or removed from the collection, or null.

Remove(value)

Removes the specified item from the ComboBox.

Parameter	Type	Description
value	Object	The Object to remove from the list.

RemoveAt(index)

Removes an item from the ComboBox 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.

Render()

Renders the list to the json definition for the client.

Returns: Object.

SetItem(index, value)

Changes a single element in the list.

Parameter	Type	Description
index	Int32	The index of the item to change.
value	Object	The new value of the item.

Sort()

Events

CollectionChanged

CollectionChangeEventHandler Fired when the collection changes.