NanoByte.Common  2.6.1
NanoByte.Common.Controls.FilteredTreeView< T > Class Template Reference

Displays a list of INameds objects in a TreeView with incremental search. An automatic hierarchy is generated based on a Separator character. More...

Inheritance diagram for NanoByte.Common.Controls.FilteredTreeView< T >:

Public Member Functions

void UpdateList (object? sender=null)
 Updates the filtered TreeView representation of Nodes. More...
 

Protected Member Functions

override void Dispose (bool disposing)
 Clean up any resources being used. More...
 

Properties

bool ShowSearchBox [get, set]
 Toggle the visibility of the search box. More...
 
NamedCollection< T >? Nodes [get, set]
 The INamed (and optionally IContextMenu) objects to be listed in the tree. More...
 
T? SelectedEntry [get, set]
 The INamed object currently selected in the TreeView; null for no selection. More...
 
ICollection< T > CheckedEntries [get]
 Returns a list of all INamed objects currently marked with a check box. More...
 
char Separator [get, set]
 The character used to separate namespaces in the INamed.Names. This controls how the tree structure is generated. More...
 
bool CheckBoxes [get, set]
 Controls whether check boxes are displayed for every entry. More...
 

Events

EventHandler? SelectedEntryChanged
 Occurs whenever SelectedEntry has been changed. More...
 
EventHandler? SelectionConfirmed
 Occurs when the user has confirmed the SelectedEntry via double-clicking or pressing Enter. More...
 
EventHandler? CheckedEntriesChanged
 Occurs whenever the content of CheckedEntries has changed. More...
 

Detailed Description

Displays a list of INameds objects in a TreeView with incremental search. An automatic hierarchy is generated based on a Separator character.

Template Parameters
TThe type of INamed object to list. Special support for types implementing IHighlightColor and/or IContextMenu.

Member Function Documentation

◆ Dispose()

override void NanoByte.Common.Controls.FilteredTreeView< T >.Dispose ( bool  disposing)
inlineprotected

Clean up any resources being used.

Parameters
disposingtrue if managed resources should be disposed; otherwise, false.

◆ UpdateList()

void NanoByte.Common.Controls.FilteredTreeView< T >.UpdateList ( object?  sender = null)
inline

Updates the filtered TreeView representation of Nodes.

Called automatically internally.

Property Documentation

◆ CheckBoxes

bool NanoByte.Common.Controls.FilteredTreeView< T >.CheckBoxes
getset

Controls whether check boxes are displayed for every entry.

CheckedEntries

◆ CheckedEntries

ICollection<T> NanoByte.Common.Controls.FilteredTreeView< T >.CheckedEntries
get

Returns a list of all INamed objects currently marked with a check box.

Does NOT create a defensive copy. Take care to only add valid elements when modifying. Call UpdateList after changing.

CheckBoxes

◆ Nodes

The INamed (and optionally IContextMenu) objects to be listed in the tree.

◆ SelectedEntry

T? NanoByte.Common.Controls.FilteredTreeView< T >.SelectedEntry
getset

The INamed object currently selected in the TreeView; null for no selection.

◆ Separator

char NanoByte.Common.Controls.FilteredTreeView< T >.Separator
getset

The character used to separate namespaces in the INamed.Names. This controls how the tree structure is generated.

◆ ShowSearchBox

bool NanoByte.Common.Controls.FilteredTreeView< T >.ShowSearchBox
getset

Toggle the visibility of the search box.

Event Documentation

◆ CheckedEntriesChanged

EventHandler? NanoByte.Common.Controls.FilteredTreeView< T >.CheckedEntriesChanged

Occurs whenever the content of CheckedEntries has changed.

◆ SelectedEntryChanged

EventHandler? NanoByte.Common.Controls.FilteredTreeView< T >.SelectedEntryChanged

Occurs whenever SelectedEntry has been changed.

◆ SelectionConfirmed

EventHandler? NanoByte.Common.Controls.FilteredTreeView< T >.SelectionConfirmed

Occurs when the user has confirmed the SelectedEntry via double-clicking or pressing Enter.


The documentation for this class was generated from the following files: