Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

• Control

  • ListControl

    • ComboBox

Represents a combo box control.

public class ComboBox : ListControl, IModified, ILabel, IReadOnly

Public Class ComboBox
    Inherits ListControl
    Implements IModified, ILabel, IReadOnly

Constructors

ComboBox()

Initializes an instance of ComboBox.

ComboBox(onSelectedIndexChanged)

Initializes a new instance of ComboBox class with specific initial settings.

ComboBox(label, onSelectedIndexChanged)

Initializes a new instance of ComboBox class with specific initial settings.

Initializes a new instance of ComboBox class with specific initial settings.

Initializes an instance of ComboBox with the given datasource, size, location, and action.

Initializes an instance of ComboBox with the given datasource, size, location, and action.

Initializes an instance of ComboBox with the given datasource, size, location, and action.

Initializes an instance of ComboBox with the given datasource, size, location, and action.

Properties

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

AutoCompleteMode: Returns or sets how automatic completion works for the ComboBox. (Default: None)

Boolean: Returns or sets whether the height of the control is set automatically. (Default: True)

CharacterCasing: Returns or sets whether the ComboBox control modifies the case of characters as they are typed. (Default: Normal)

Int32: Returns or sets the maximum height in pixels of the drop-down portion of the ComboBox. (Default: 400)

Throws:

• ArgumentException The specified value is less than one.

ComboBoxStyle: Returns or sets the drop down style of the combo box. (Default: DropDown)

Int32: Returns or sets the maximum width in pixels of the drop-down list of the ComboBox. When the value is 0, the drop-down list will grow to fit the largest item. (Default: 0)

Throws:

• ArgumentException The specified value is less than one.

Boolean: Returns or sets whether the combo box is displaying its drop-down portion.

Boolean: Enables or disables the browser's context menu. (Default: True)

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 in the drop-down list. 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 ComboBox.

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 are sent to the client the first time the list is opened and enables the Load event. (Default: False)

Int32: Returns or sets the number of characters a user can type into the ComboBox. (Default: 0)

Throws:

• ArgumentOutOfRangeException The value is less than 0.

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

Int32: Returns or sets the index of the currently selected item.

Throws:

• ArgumentOutOfRangeException The specified index is less than -1; o the specified index is greater than the number of items in the combo box.

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

String: Returns or sets the text that is selected in the editable portion of a ComboBox.

Int32: Returns or sets the number of characters selected in the editable portion of the combo box.

Throws:

• ArgumentException The value was less than zero.

Int32: Returns or sets the starting index of text selected in the combo box.

Throws:

• ArgumentException The value is less than zero.

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

Throws:

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

Boolean: Returns or sets whether the text in the ComboBox is spell checked by the browser. (Default: False)

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

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

String: Returns or sets the text to show when the control is empty. (Default: null)

Methods

Not used. Kept for compatibility.

Copies the current selection in the text box to the Clipboard.

Moves the current selection in the text box to the Clipboard.

Not used. Kept for compatibility.

Returns the index of the first item in the ComboBox 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 ComboBox 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.

Replaces the current selection in the text box with the contents of the Clipboard.

Selects a range of text in the editable portion of the ComboBox.

Selects all the text in the editable portion of the ComboBox.

Events

HandledEventHandler Fired before the Validating event when DropDownStyle is set to DropDown or Simple.

The application may implement a different way to select the item when the user types a text and the ComboBox is validated. Set e.Handled to true to override the standard behavior.

this.comboBox1.AutoComplete += (s, e) =>
{
  if (this.comboBox1.Text == "T")
  {
    this.compoBox1.SelectedIndex = 1;
    e.Handled = true;
  }
}

EventHandler Fired when the drop-down portion of a ComboBox is shown.

EventHandler Fired when the drop-down portion of the ComboBox is no longer visible.

EventHandler Fired when the DropDownStyle property has changed.

EventHandler Fired when the drop-down list is first opened and the LazyLoading property is true.

When LazyLoading is true An application may fill the items at any time prior to the drop-down list being opened, or while processing the DropDown or Load event.

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

EventHandler Fired when the SelectedIndex property has changed.

EventHandler Fired when the SelectedItem property has changed.

EventHandler Fired when the selected item has changed and that change is displayed in the ComboBox.

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.5.0.0)

Represents the collection of items in a Wisej.Web.ComboBox 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 ComboBox.

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.

Removes all items from the ComboBox.

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 ComboBox.

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