ListBox

Wisej.Web.ListBox

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents a control to display a list of items.

public class ListBox : ListControl, IModified, ILabel, IReadOnly

Constructors

Initializes a new instance of ListBox.

Initializes a new instance of the ListBox class with the specified settings.

Initializes a new instance of ListBox class with the specified settings.

Initializes a new instance of the ListBox class with the specified settings.

Initializes a new instance of the ListBox class with the specified settings.

Properties

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

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:

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:

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:

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:

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:

Selects all the items in the ListBox.

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

Throws:

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

Last updated