Table of Contents

Class ComboBox

Namespace
Terminal.Gui
Assembly
Terminal.Gui.dll

Provides a drop-down list of items the user can select from.

public class ComboBox : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
Inheritance
ComboBox
Implements
Inherited Members

Constructors

ComboBox()

Public constructor

ComboBox(ustring)

Public constructor

ComboBox(IList)

Initialize with the source.

ComboBox(Rect, IList)

Public constructor

Properties

ColorScheme
HideDropdownListOnClick

Gets or sets if the drop-down list can be hide with a button click event.

IsShow

Gets the drop down list state, expanded or collapsed.

ReadOnly

If set to true its not allow any changes in the text.

SearchText

Current search text

SelectedItem

Gets the index of the currently selected item in the Source

Source

Gets or sets the IListDataSource backing this ComboBox, enabling custom rendering.

Text

The currently selected list item

Methods

Collapse()

Collapses the drop down list. Returns true if the state chagned or false if it was already collapsed and no action was taken

Expand()

Expands the drop down list. Returns true if the state chagned or false if it was already expanded and no action was taken

MouseEvent(MouseEvent)

Method invoked when a mouse event is generated

OnCollapsed()

Virtual method which invokes the Collapsed event.

OnEnter(View)

Method invoked when a view gets focus.

OnExpanded()

Virtual method which invokes the Expanded event.

OnLeave(View)

Method invoked when a view loses focus.

OnOpenSelectedItem()

Invokes the OnOpenSelectedItem event if it is defined.

OnSelectedChanged()

Invokes the SelectedChanged event if it is defined.

ProcessKey(KeyEvent)

If the view is focused, gives the view a chance to process the keystroke.

Redraw(Rect)

Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.

SetSource(IList)

Sets the source of the ComboBox to an IList.

Events

Collapsed

This event is raised when the drop-down list is collapsed.

Expanded

This event is raised when the drop-down list is expanded.

OpenSelectedItem

This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item.

SelectedItemChanged

This event is raised when the selected item in the ComboBox has changed.