Skip to content
ConsoleMonster
Class

TreeSelect

ConsoleMonster.Interactive

Edit on GitHub
Namespace
ConsoleMonster.Interactive
Assembly
ConsoleMonster
Source
TreeSelect.cs:14
Base
InputControl
Implements
IWidget
Modifiers
sealed

An embeddable, budgeted object tree using the explorer's lazy nodes, cycle guards and expansion limits.

Inheritance

Usage

Explore 25 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 13

Accepted by parameters 12

Constructors

public TreeSelect(string key, ObjectExplorer explorer) #
TreeSelect.cs:14

Creates a retained tree over an existing lazy explorer model.

Parameters

key string required
explorer ConsoleMonster.Interactive.ObjectExplorer required

Methods

public void Back() #
TreeSelect.cs:49

Returns to the previous subtree and cursor.

public void Collapse() #
TreeSelect.cs:45

Collapses the selected node or its expanded parent.

public void Drill() #
TreeSelect.cs:47

Browses the selected node as a new subtree.

public void Expand() #
TreeSelect.cs:43

Expands the selected node within the model's budget.

public void Move(int amount) #
TreeSelect.cs:41

Moves within the flattened visible nodes.

Parameters

amount int required

Properties

public ExplorerNode Root { get; } #
TreeSelect.cs:30

The subtree currently being browsed.

public ExplorerNode Selected { get; } #
TreeSelect.cs:32

The selected original node and its path.

public int VisibleCount { get; } #
TreeSelect.cs:34

The number of currently visible nodes, bounded by InspectorOptions.MaxNodes.

public int Height { get; set; } #
TreeSelect.cs:37

Natural viewport rows.

public string Filter { get; set; } #
TreeSelect.cs:39

The substring search over node names and bounded display values.

Extension Methods

Disabled 2 overloads
public static TreeSelect Disabled(TreeSelect treeSelect, bool value) #

Sets InputControl.Disabled: Whether this control is excluded from input and focus traversal.

Parameters

treeSelect ConsoleMonster.Interactive.TreeSelect required
The instance.
value bool required
The value.

Returns

TreeSelect The same instance.

Examples

// C# initializer or property    // C# fluent
treeSelect.Disabled = value;     treeSelect.Disabled(value);
public static TreeSelect Disabled(TreeSelect treeSelect) #

Sets InputControl.Disabled to true.

Parameters

treeSelect ConsoleMonster.Interactive.TreeSelect required
The instance to configure.

Returns

TreeSelect The same instance.
public static TreeSelect Filter(TreeSelect treeSelect, string value) #

Sets TreeSelect.Filter: The substring search over node names and bounded display values.

Parameters

treeSelect ConsoleMonster.Interactive.TreeSelect required
The instance.
value string required
The value.

Returns

TreeSelect The same instance.

Examples

// C# initializer or property    // C# fluent
treeSelect.Filter = value;       treeSelect.Filter(value);
public static TreeSelect Height(TreeSelect treeSelect, int value) #

Sets TreeSelect.Height: Natural viewport rows.

Parameters

treeSelect ConsoleMonster.Interactive.TreeSelect required
The instance.
value int required
The value.

Returns

TreeSelect The same instance.

Examples

// C# initializer or property    // C# fluent
treeSelect.Height = value;       treeSelect.Height(value);
public static TreeSelect Label(TreeSelect treeSelect, string? value) #

Sets InputControl.Label: The visible label, or null to use the name.

Parameters

treeSelect ConsoleMonster.Interactive.TreeSelect required
The instance.
value string? required
The value.

Returns

TreeSelect The same instance.

Examples

// C# initializer or property    // C# fluent
treeSelect.Label = value;        treeSelect.Label(value);
public static TreeSelect TabIndex(TreeSelect treeSelect, int value) #

Sets InputControl.TabIndex: Focus order; equal values preserve declaration order.

Parameters

treeSelect ConsoleMonster.Interactive.TreeSelect required
The instance.
value int required
The value.

Returns

TreeSelect The same instance.

Examples

// C# initializer or property    // C# fluent
treeSelect.TabIndex = value;     treeSelect.TabIndex(value);
public static TreeSelect ValidationMessage(TreeSelect treeSelect, string? value) #

Sets InputControl.ValidationMessage: The current validation message below the control, or null.

Parameters

treeSelect ConsoleMonster.Interactive.TreeSelect required
The instance.
value string? required
The value.

Returns

TreeSelect The same instance.

Examples

// C# initializer or property            // C# fluent
treeSelect.ValidationMessage = value;    treeSelect.ValidationMessage(value);