Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

• Control

  • ListControl

    • ListBox

Represents a control to display a list of items.

public class ListBox : ListControl, IModified, ILabel, IReadOnly

Public Class ListBox
    Inherits ListControl
    Implements IModified, ILabel, IReadOnly

Constructors

ListBox()

Initializes a new instance of ListBox.

Properties

AllowHtml

Boolean: Returns or sets a value indicating that the control can display HTML in the Text property. (Default: False)

HorizontalScrollbar

Boolean: Returns or sets whether a horizontal scroll bar is displayed in the control. (Default: False)

Boolean: Returns or sets whether items are selected incrementally as the user types within a timeout of 1 second. (Default: True)

Int32: Gets or sets the height of the list items. When the value is -1, uses the value set in the theme. (Default: -1)

Throws:

• ArgumentOutOfRangeException The assigned value is less than -1; or the assigned value is greater than 500.

ObjectCollection: Returns the collection of the items contained in this ListBox.

LabelWrapper: Provides a label related to the control.

String: Returns or sets the localizable label associated with this control. (Default: "")

Boolean: Returns or sets whether the items in the list are send to the client when the list becomes visible the first time. (Default: False)

Orientation: Returns or sets whether the list box displays the items vertically (default) or horizontally. [Since 3.1] (Default: Vertical)

Throws:

• InvalidOperationException Horizontal orientation is not supported with virtual scrolling.

Boolean: Returns or sets whether the control is read-only. (Default: False)

Boolean: Returns or sets whether the item under the pointer gets selected on a right click. (Default: False)

When the right click lands outside of a selected area the selection is not changed regardless of the value of RightClickSelection.

Boolean: Returns or sets whether the vertical scroll bar is shown at all times. (Default: False)

Int32: Returns or sets the zero-based index of the currently selected item in a ListBox.

Throws:

• ArgumentOutOfRangeException The assigned value is less than -1 or greater than or equal to the item count.

• ArgumentException The SelectionMode property is set to None.

SelectedIndexCollection: Returns a collection that contains the zero-based indexes of all currently selected items in the ListBox.

Object: Returns or sets the currently selected item in the ListBox.

SelectedObjectCollection: Returns a collection containing the currently selected items in the ListBox.

SelectionMode: Returns or sets the method in which items are selected in the ListBox. (Default: One)

Boolean: Returns or sets whether the items in the combo box are sorted. (Default: False)

Throws:

• ArgumentException An attempt was made to sort a ListBox that is attached to a data source.

ComponentToolCollection: Returns the instance of ComponentToolCollection associated with this control.

Int32: Returns or sets the index of the first visible item in the ListBox.

Methods

Not used. Kept for compatibility.

Unselects all items in the ListBox.

Not used. Kept for compatibility.

Returns the index of the first item in the ListBox that starts with the specified string.

Returns: Int32. The zero-based index of the first item found; returns -1 if no match is found.

Returns the index of the first item in the ListBox beyond the specified index that contains the specified string. The search is not case sensitive.

Returns: Int32. The zero-based index of the first item found; returns -1 if no match is found, or 0 if the text parameter specifies Empty.

Finds the first item in the combo box that matches the specified string.

Returns: Int32. The zero-based index of the first item found; returns -1 if no match is found, or 0 if the text parameter specifies Empty.

Finds the first item after the specified index that matches the specified string.

Returns: Int32. The zero-based index of the first item found; returns -1 if no match is found, or 0 if the text parameter specifies Empty.

Returns a value indicating whether the specified item is selected.

Returns: Boolean. true if the specified item is currently selected in the ListBox; otherwise, false.

Throws:

• ArgumentOutOfRangeException The specified index was outside the range of valid values.

Selects all the items in the ListBox.

Selects or clears the selection for the specified item in a ListBox.

Throws:

• ArgumentOutOfRangeException The specified index was outside the range of valid values.

• InvalidOperationException The SelectionMode property is set to None.

Events

EventHandler Fired when the LazyLoading property is true and the ListBox is first shown.

When LazyLoading is true An application may fill the items at any time prior to the ListBox being shown, or while processing the Load event.

EventHandler Fired when the value of the ReadOnly property has changed.

EventHandler Fired when the SelectedIndex property or the SelectedIndices collection has changed.

EventHandler Fired when the Sorted property has changed.

ToolClickEventHandler Fired when a ComponentTool is clicked.

Inherited By

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Represents the collection containing the indexes to the selected items in a ListBox.

public class SelectedIndexCollection : IList, ICollection, IEnumerable

Public Class SelectedIndexCollection
    Inherits IList
    Implements ICollection, IEnumerable

Properties

Count

Int32: Returns the number of selected items.

IsReadOnly

Boolean: Returns whether the collection is read-only.

Item(index)

Int32: Returns the index of the selected item.

Methods

Add(index)

Selects the item at the specified index.

Clears all the selected items.

Checks if the specified index is in the selected items collection.

Returns: Boolean.

Returns: IEnumerator.

Finds the selected index in the collection.

Returns: Int32.

Unselects the specified index.

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Represents the collection of selected items in the ListBox.

public class SelectedObjectCollection : IList, ICollection, IEnumerable

Public Class SelectedObjectCollection
    Inherits IList
    Implements ICollection, IEnumerable

Properties

Count

Int32: Returns the number of selected items.

IsReadOnly

Boolean: Returns whether the collection is read-only.

Item(index)

Object: Returns the selected item.

Methods

Add(value)

Returns: Boolean.

Returns: IEnumerator.

Returns: Int32.

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

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

public class ObjectCollection : IList, ICollection, IEnumerable

Public Class ObjectCollection
    Inherits IList
    Implements ICollection, IEnumerable

Properties

Count

Int32: Returns the number of items in the collection.

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

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

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

Throws:

• ArgumentNullException The item parameter was null.

Adds a collection of items to the list.

Throws:

• ArgumentNullException items is null.

Removes all items from the ListBox.

Determines if the specified item is located within the collection.

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

Throws:

• ArgumentNullException value is null.

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

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

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

Retrieves the index within the collection of the specified item.

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

Throws:

• ArgumentNullException The value parameter was null.

Inserts an item into the collection at the specified index.

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.

Removes the specified item from the ListBox.

Removes an item from the ListBox at the specified index.

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.

Events

CollectionChangeEventHandler Fired when the collection changes.

Inherited By