DomainUpDown.DomainUpDownItemCollection

Wisej.Web.DomainUpDown DomainUpDownItemCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Encapsulates a collection of objects for use by the DomainUpDown class.

C#

public class DomainUpDownItemCollection : IList, ICollection, IEnumerable

VB.NET

Public Class DomainUpDownItemCollection
    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.

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 object to the end of the collection.

Parameter	Type	Description
item	Object	The Object to be added to the end of the collection. The value can be null.

Returns: Int32. The index at which the item has been added.

AddRange(items)

Adds a collection of objects to the end of the collection.

Parameter	Type	Description
items	Object[]	Items to add to the end of the collection.

Clear()

Removes all items from the DomainUpDown control.

Contains(item)

Determines if the specified item is located within the collection.

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

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

GetEnumerator()

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

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

IndexOf(item)

Retrieves the index within the collection of the specified item.

Parameter	Type	Description
item	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 item parameter was null.

Insert(index, item)

Inserts an element into the collection at the specified index.

Parameter	Type	Description
index	Int32	The zero-based index at which item should be inserted.
item	Object	The Object to insert. The value can be null.

Throws:

• ArgumentOutOfRangeException index is less than zero, or index is greater than number of items in the collection.

Remove(item)

Removes the first occurrence of a specific object from the collection.

Parameter	Type	Description
item	Object	The Object to remove from the collection. The value can be null.

RemoveAt(index)

Removes the element at the specified index of the collection.

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

Throws:

• ArgumentOutOfRangeException index is less than zero; or index is equal to or greater than number of items in the collection.

Render()

Renders the list to the json definition for the client.

Returns: Object.

Sort()