C# Class SIL.FieldWorks.Common.Widgets.TreeCombo

TreeCombo is like a combo box except that it uses a PopupTree to display a hierarchy of options.

Only a minimum of Combo box features currently needed is implemented.

The key event is 'AfterSelect' which is triggered when an item in the popup tree is selected.

Inheritance: FwComboBoxBase
Mostrar archivo Open project: sillsdev/FieldWorks Class Usage Examples

Private Properties

Property Type Description
GetFontOverrideInfo FontOverrideInfo
SetComboTextAndFocus void
m_button_KeyPress void
m_comboTextBox_KeyPress void
m_popupTree_BeforeSelect void
m_popupTree_PopupTreeClosed void
m_tree_AfterSelect void
m_tree_Load void

Public Methods

Method Description
SetComboText ( TreeNode node ) : void

Sets the text but doesn't cause a focus.
TreeCombo ( ) : System

Construct one.

Protected Methods

Method Description
CreateDropDownBox ( ) : IDropDownBox

Creates the drop down box.
Dispose ( bool disposing ) : void

Clean up any resources being used.

Private Methods

Method Description
GetFontOverrideInfo ( string source, int wsTreeCombo ) : FontOverrideInfo
SetComboTextAndFocus ( TreeNode node ) : void

Sets the text and focuses the control FWNX-270: renamed from SetComboText to make it clear that this method causes a focus
m_button_KeyPress ( object sender, KeyPressEventArgs e ) : void
m_comboTextBox_KeyPress ( object sender, KeyPressEventArgs e ) : void

Handle a key press in the combo box. Enable type-ahead to select list items (LT-2190).
m_popupTree_BeforeSelect ( object sender, System.Windows.Forms.TreeViewCancelEventArgs e ) : void
m_popupTree_PopupTreeClosed ( object sender, TreeViewEventArgs e ) : void
m_tree_AfterSelect ( object sender, TreeViewEventArgs e ) : void
m_tree_Load ( object sender, EventArgs e ) : void

Method Details

CreateDropDownBox() protected method

Creates the drop down box.
protected CreateDropDownBox ( ) : IDropDownBox
return IDropDownBox

Dispose() protected method

Clean up any resources being used.
protected Dispose ( bool disposing ) : void
disposing bool
return void

SetComboText() public method

Sets the text but doesn't cause a focus.
public SetComboText ( TreeNode node ) : void
node System.Windows.Forms.TreeNode
return void

TreeCombo() public method

Construct one.
public TreeCombo ( ) : System
return System