Class ComboBox
Provides a drop-down list of items the user can select from.
Inherited Members
Namespace: Terminal.Gui
Assembly: Terminal.Gui.dll
Syntax
public class ComboBox : View, IDisposable, ISupportInitializeNotification, ISupportInitializeConstructors
| Edit this page View SourceComboBox()
Public constructor
Declaration
public ComboBox()ComboBox(ustring)
Public constructor
Declaration
public ComboBox(ustring text)Parameters
| Type | Name | Description |
|---|---|---|
| ustring | text |
ComboBox(IList)
Initialize with the source.
Declaration
public ComboBox(IList source)Parameters
| Type | Name | Description |
|---|---|---|
| IList | source | The source. |
ComboBox(Rect, IList)
Public constructor
Declaration
public ComboBox(Rect rect, IList source)Parameters
| Type | Name | Description |
|---|---|---|
| Rect | rect | |
| IList | source |
Properties
| Edit this page View SourceColorScheme
Declaration
public ColorScheme ColorScheme { get; set; }Property Value
| Type | Description |
|---|---|
| ColorScheme |
HideDropdownListOnClick
Gets or sets if the drop-down list can be hide with a button click event.
Declaration
public bool HideDropdownListOnClick { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
IsShow
Gets the drop down list state, expanded or collapsed.
Declaration
public bool IsShow { get; }Property Value
| Type | Description |
|---|---|
| bool |
ReadOnly
If set to true its not allow any changes in the text.
Declaration
public bool ReadOnly { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
SearchText
Current search text
Declaration
public ustring SearchText { get; set; }Property Value
| Type | Description |
|---|---|
| ustring |
SelectedItem
Gets the index of the currently selected item in the Source
Declaration
public int SelectedItem { get; set; }Property Value
| Type | Description |
|---|---|
| int | The selected item or -1 none selected. |
Source
Gets or sets the IListDataSource backing this ComboBox, enabling custom rendering.
Declaration
public IListDataSource Source { get; set; }Property Value
| Type | Description |
|---|---|
| IListDataSource | The source. |
Remarks
Use SetSource(IList) to set a new IList source.
|
Edit this page
View Source
Text
The currently selected list item
Declaration
public ustring Text { get; set; }Property Value
| Type | Description |
|---|---|
| ustring |
Methods
| Edit this page View SourceCollapse()
Collapses the drop down list. Returns true if the state chagned or false
if it was already collapsed and no action was taken
Declaration
public virtual bool Collapse()Returns
| Type | Description |
|---|---|
| bool |
Expand()
Expands the drop down list. Returns true if the state chagned or false
if it was already expanded and no action was taken
Declaration
public virtual bool Expand()Returns
| Type | Description |
|---|---|
| bool |
MouseEvent(MouseEvent)
Method invoked when a mouse event is generated
Declaration
public override bool MouseEvent(MouseEvent me)Parameters
| Type | Name | Description |
|---|---|---|
| MouseEvent | me |
Returns
| Type | Description |
|---|---|
| bool | true, if the event was handled, false otherwise. |
Overrides
| Edit this page View SourceOnCollapsed()
Virtual method which invokes the Collapsed event.
Declaration
public virtual void OnCollapsed()OnEnter(View)
Method invoked when a view gets focus.
Declaration
public override bool OnEnter(View view)Parameters
| Type | Name | Description |
|---|---|---|
| View | view | The view that is losing focus. |
Returns
| Type | Description |
|---|---|
| bool | true, if the event was handled, false otherwise. |
Overrides
| Edit this page View SourceOnExpanded()
Virtual method which invokes the Expanded event.
Declaration
public virtual void OnExpanded()OnLeave(View)
Method invoked when a view loses focus.
Declaration
public override bool OnLeave(View view)Parameters
| Type | Name | Description |
|---|---|---|
| View | view | The view that is getting focus. |
Returns
| Type | Description |
|---|---|
| bool | true, if the event was handled, false otherwise. |
Overrides
| Edit this page View SourceOnOpenSelectedItem()
Invokes the OnOpenSelectedItem event if it is defined.
Declaration
public virtual bool OnOpenSelectedItem()Returns
| Type | Description |
|---|---|
| bool |
OnSelectedChanged()
Invokes the SelectedChanged event if it is defined.
Declaration
public virtual bool OnSelectedChanged()Returns
| Type | Description |
|---|---|
| bool |
ProcessKey(KeyEvent)
If the view is focused, gives the view a
chance to process the keystroke.
Declaration
public override bool ProcessKey(KeyEvent e)Parameters
| Type | Name | Description |
|---|---|---|
| KeyEvent | e |
Returns
| Type | Description |
|---|---|
| bool |
Overrides
Remarks
Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process.
The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses.
Redraw(Rect)
Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
Declaration
public override void Redraw(Rect bounds)Parameters
| Type | Name | Description |
|---|---|---|
| Rect | bounds | The bounds (view-relative region) to redraw. |
Overrides
Remarks
Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative).
Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver.
Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region
larger than the parameter, as this will cause the driver to clip the entire region.
SetSource(IList)
Declaration
public void SetSource(IList source)Parameters
| Type | Name | Description |
|---|---|---|
| IList | source |
Remarks
Use the Source property to set a new IListDataSource source and use custome rendering.
Events
| Edit this page View SourceCollapsed
This event is raised when the drop-down list is collapsed.
Declaration
public event Action CollapsedEvent Type
| Type | Description |
|---|---|
| Action |
Expanded
This event is raised when the drop-down list is expanded.
Declaration
public event Action ExpandedEvent Type
| Type | Description |
|---|---|
| Action |
OpenSelectedItem
This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item.
Declaration
public event Action<ListViewItemEventArgs> OpenSelectedItemEvent Type
| Type | Description |
|---|---|
| Action<ListViewItemEventArgs> |
SelectedItemChanged
This event is raised when the selected item in the ComboBox has changed.
Declaration
public event Action<ListViewItemEventArgs> SelectedItemChangedEvent Type
| Type | Description |
|---|---|
| Action<ListViewItemEventArgs> |