ListBox

Wisej.Web.ListBox

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

• Control

  • ListControl

    • ListBox

Represents a control to display a list of items.

C#

public class ListBox : ListControl, ILabel, IReadOnly

VB.NET

Constructors

ListBox()

Initializes a new instance of ListBox.

ListBox(onSelectedIndexChanged)

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

Name	Type	Description
onSelectedIndexChanged	Action<Object, EventArgs>	Optional SelectedIndexChanged handler.

ListBox(dataSource, displayMember, valueMember, iconMember, onSelectedIndexChanged)

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

Name	Type	Description
dataSource	Object	Initial DataSource.
displayMember	String	Initial DisplayMember.
valueMember	String	Initial ValueMember.
iconMember	String	Initial IconMember.
onSelectedIndexChanged	Action<Object, EventArgs>	Optional SelectedIndexChanged handler.

ListBox(location, size, onSelectedIndexChanged)

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

Name	Type	Description
location	Point	Initial location.
size	Size	Initial size.
onSelectedIndexChanged	Action<Object, EventArgs>	Optional SelectedIndexChanged handler.

ListBox(location, size, dataSource, displayMember, valueMember, iconMember, onSelectedIndexChanged)

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

Name	Type	Description
location	Point	Initial location.
size	Size	Initial size.
dataSource	Object	Initial DataSource.
displayMember	String	Initial DisplayMember.
valueMember	String	Initial ValueMember.
iconMember	String	Initial IconMember.
onSelectedIndexChanged	Action<Object, EventArgs>	Optional SelectedIndexChanged handler.

Properties

AllowHtml

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

AllowSelection

Boolean: Returns a value indicating whether the ListBox currently enables selection of list items.

DefaultSize

Size: Returns the default size for a text box control.

HorizontalScrollbar

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

IncrementalSelection

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

ItemHeight

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.

Items

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

Label

LabelWrapper: Provides a label related to the control.

LabelText

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

LazyLoading

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

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.

ReadOnly

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

RightClickSelection

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.

ScrollAlwaysVisible

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

SelectedIndex

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.

SelectedIndices

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

SelectedItem

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

SelectedItems

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

SelectionMode

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

Sorted

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.

Tools

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

TopIndex

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

Methods

BeginUpdate()

Not used. Kept for compatibility.

ClearSelected()

Unselects all items in the ListBox.

CreateItemCollection()

Creates a new instance of the item collection.

Returns: ObjectCollection. A ObjectCollection that represents the new item collection.

Dispose(disposing)

Disposes the control.

Parameter	Type	Description
disposing	Boolean	true when this method is called by the application rather than a finalizer.

EndUpdate()

Not used. Kept for compatibility.

FindString(text)

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

Parameter	Type	Description
text	String	The String to search for.

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

FindString(text, startIndex)

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.

Parameter	Type	Description
text	String	The String to search for.
startIndex	Int32	The zero-based index of the item before the first item to be searched. Set to -1 to search from the beginning of the control.

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.

FindStringExact(text)

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

Parameter	Type	Description
text	String	The String to search for.

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.

FindStringExact(text, startIndex)

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

Parameter	Type	Description
text	String	The String to search for.
startIndex	Int32	The zero-based index of the item before the first item to be searched. Set to -1 to search from the beginning of the control.

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.

GetSelected(index)

Returns a value indicating whether the specified item is selected.

Parameter	Type	Description
index	Int32	The zero-based index of the item that determines whether it 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.

OnDataSourceChanged(e)

Fires the DataSourceChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnDisplayMemberChanged(e)

Fires the DisplayMemberChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnLoad(e)

Fires the Load event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnReadOnlyChanged(e)

Fires the ReadOnlyChanged event.

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

OnSelectedIndexChanged(e)

Fires the SelectedIndexChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnSortedChanged(e)

Fires the SortedChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnToolClick(e)

Fires the ToolClick event.

Parameter	Type	Description
e	ToolClickEventArgs	A ToolClickEventArgs that contains the event data.

OnValueMemberChanged(e)

Fires the ValueMemberChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnWebEvent(e)

Processes the event from the client.

Parameter	Type	Description
e	WisejEventArgs	Event arguments.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

OnWebUpdate(state)

Updates the client component using the state information.

Parameter	Type	Description
state	Object	Dynamic state object.

RefreshItem(index)

Refreshes the item contained at the specified location.

Parameter	Type	Description
index	Int32	The location of the item to refresh.

RefreshItems()

Reloads all the ListBox items from the data source.

SelectAll()

Selects all the items in the ListBox.

SetItemCore(index, value)

Sets the object with the specified index in the derived class.

Parameter	Type	Description
index	Int32	The array index of the object.
value	Object	The object.

SetItemsCore(value)

Sets the specified array of objects in a collection in the derived class.

Parameter	Type	Description
value	IList	An array of items.

SetSelected(index, selected)

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

Parameter	Type	Description
index	Int32	The zero-based index of the item in a ListBox to select or clear the selection for.
selected	Boolean	true to select the specified item; otherwise, false.

Throws:

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

• InvalidOperationException The SelectionMode property is set to None.

Sort()

Sorts the items in the ListBox.

Events

Load

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.

ReadOnlyChanged

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

SelectedIndexChanged

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

SortedChanged

EventHandler Fired when the Sorted property has changed.

ToolClick

ToolClickEventHandler Fired when a ComponentTool is clicked.

Inherited By

Name	Description
CheckedListBox	Displays a ListBox in which a check box is displayed to the left of each item.

Implements

Name	Description
IUserData	Provides access to the UserData and Tag properties associated to the component implementing this interface.
IBindableComponent	Bindable components implement this interface.
IDropTarget	Controls that support drag & drop operations implement this interface.
ILabel	Provides access to the LabelWrapper associated with the controls that implement this interface.
IReadOnly	Provides access to the ReadOnly property for coontrols that support the read-only mode.
IModified	Provides access to the Modified property and ModifiedChanged event for controls that implement this interface.
IValidation	Provides access to the validation events and properties property for controls that support validation.
IWisejComponent	All wisej components implement this interface.
IWisejControl	All wisej controls derived from the Control class must implement this interface.
IWisejSerializable	Allows an object to serialize itself.