C# Class SIL.FieldWorks.Common.Controls.ChooserTreeView

Inheritance: SIL.FieldWorks.Common.Controls.TriStateTreeView
Show file Open project: sillsdev/FieldWorks Class Usage Examples

Protected Properties

Property Type Description
m_initiallyCheckedNodes List
m_initiallySelectedHvos List

Public Methods

Method Description
Load ( ICmPossibilityList list, List initiallySelectedHvos ) : void

Loads the tree with the specified list of possibilities.

Load ( ICmPossibilityList list, List initiallySelectedHvos, Label lblSelectedCategories ) : void

Loads the tree with the specified list of possibilities.

UpdateSelectedLabel ( ) : void

Protected Methods

Method Description
CreateNode ( ICmPossibility possibility ) : TreeNode

Create a node for a possibility (including populating its child nodes)

GetPossibilityText ( ICmPossibility possibility ) : string

Get the text representing the possibility.

GetSelectedItems ( TreeNode node, List selectedItems ) : void

Gets the selected items for the specified node and its children.

IsNodeSelected ( TreeNode node ) : bool

Gets a value indicating whether or not the specified node is selected. For it to be selected, it has to checked while its parent is not.

OnAfterCheck ( TreeViewEventArgs e ) : void

OnHandleCreated ( EventArgs e ) : void

Overrides M:System.Windows.Forms.Control.OnHandleCreated(System.EventArgs).

PopulateChildNodes ( TreeNode node, ICmPossibility possibility ) : void

Populate the node with the children of the possibility. (recursive)

Private Methods

Method Description
GetSelectedPossibilites ( TreeNode node ) : IEnumerable

Gets the selected possibilites for the specified node and its children.

Method Details

CreateNode() protected method

Create a node for a possibility (including populating its child nodes)
protected CreateNode ( ICmPossibility possibility ) : TreeNode
possibility ICmPossibility
return System.Windows.Forms.TreeNode

GetPossibilityText() protected method

Get the text representing the possibility.
protected GetPossibilityText ( ICmPossibility possibility ) : string
possibility ICmPossibility
return string

GetSelectedItems() protected method

Gets the selected items for the specified node and its children.
protected GetSelectedItems ( TreeNode node, List selectedItems ) : void
node System.Windows.Forms.TreeNode
selectedItems List
return void

IsNodeSelected() protected method

Gets a value indicating whether or not the specified node is selected. For it to be selected, it has to checked while its parent is not.
protected IsNodeSelected ( TreeNode node ) : bool
node System.Windows.Forms.TreeNode
return bool

Load() public method

Loads the tree with the specified list of possibilities.
public Load ( ICmPossibilityList list, List initiallySelectedHvos ) : void
list ICmPossibilityList
initiallySelectedHvos List
return void

Load() public method

Loads the tree with the specified list of possibilities.
public Load ( ICmPossibilityList list, List initiallySelectedHvos, Label lblSelectedCategories ) : void
list ICmPossibilityList
initiallySelectedHvos List
lblSelectedCategories System.Windows.Forms.Label
return void

OnAfterCheck() protected method

protected OnAfterCheck ( TreeViewEventArgs e ) : void
e System.Windows.Forms.TreeViewEventArgs
return void

OnHandleCreated() protected method

Overrides M:System.Windows.Forms.Control.OnHandleCreated(System.EventArgs).
protected OnHandleCreated ( EventArgs e ) : void
e System.EventArgs An that contains the event data.
return void

PopulateChildNodes() protected method

Populate the node with the children of the possibility. (recursive)
protected PopulateChildNodes ( TreeNode node, ICmPossibility possibility ) : void
node System.Windows.Forms.TreeNode given node
possibility ICmPossibility The possibility whose subpossibilities will be added as /// the child nodes
return void

UpdateSelectedLabel() public method

public UpdateSelectedLabel ( ) : void
return void

Property Details

m_initiallyCheckedNodes protected property

protected List m_initiallyCheckedNodes
return List

m_initiallySelectedHvos protected property

protected List m_initiallySelectedHvos
return List