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, IDesignable
Inheritance
ComboBox
Implements
Inherited Members

Constructors

ComboBox()

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, no changes to the text will be allowed.

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 text of the currently selected list item

Methods

Collapse()

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

EnableForDesign()

Causes the View to enable design-time mode. This typically means that the view will load demo data and be configured to allow for design-time manipulation.

Expand()

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

OnCollapsed()

Virtual method which invokes the Collapsed event.

OnDrawingContent()

Called when the View's content is to be drawn. The default implementation does nothing.

OnExpanded()

Virtual method which invokes the Expanded event.

OnHasFocusChanged(bool, View, View)

Invoked after HasFocus has changed. This method is called before the HasFocusChanged event is raised.

OnMouseEvent(MouseEventArgs)

Called when a mouse event occurs within the view's Viewport.

OnOpenSelectedItem()

Invokes the OnOpenSelectedItem event if it is defined.

OnSelectedChanged()

Invokes the SelectedChanged event if it is defined.

SetSource<T>(ObservableCollection<T>)

Sets the source of the ComboBox to an ObservableCollection<T>.

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.