Outline
ConsoleMonster.Interactive
A list of headings to jump between: a table of contents, settings groups, the sections of a long form. The current entry (where the reader is) is marked and can follow a view as it scrolls; ↑/↓, Home/End and the wheel move the selection, and Enter or a click opens it. Opening makes the entry current, which is the control's value (so InputControl.Changed and OnChange report it), and leads to its OutlineItem.Target when it has one.
Inheritance
- InputControl
- Outline
Usage
Explore 47 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 23
- Method AppInput.Outline
- Property Breadcrumb.Outline
- Property BreadcrumbInputOptions.Outline
- Method InteractiveFluent.AddBinding
- Method InteractiveFluent.AddBindings
- Method InteractiveFluent.AddItem
- Method InteractiveFluent.AddItems
- Method InteractiveFluent.CurrentIndex
- Method InteractiveFluent.Disabled
- Method InteractiveFluent.Label
- Method InteractiveFluent.TabIndex
- Method InteractiveFluent.ValidationMessage
- Extension method Outline.AddBinding
- Extension method Outline.AddBindings
- Extension method Outline.AddItem
- Extension method Outline.AddItems
- Extension method Outline.CurrentIndex
- Extension method Outline.Disabled
- Extension method Outline.Label
- Extension method Outline.TabIndex
- Extension method Outline.ValidationMessage
- Extension method OutlineInputOptions.Build
- Method UiConstruction.Build
Accepted by parameters 24
- Extension method Breadcrumb.Outline
- Extension method Breadcrumb.Outline
- Extension method BreadcrumbInputOptions.Outline
- Extension method BreadcrumbInputOptions.Outline
- Method InteractiveFluent.AddBinding
- Method InteractiveFluent.AddBindings
- Method InteractiveFluent.AddItem
- Method InteractiveFluent.AddItems
- Method InteractiveFluent.CurrentIndex
- Method InteractiveFluent.Disabled
- Method InteractiveFluent.Label
- Method InteractiveFluent.Outline
- Method InteractiveFluent.Outline
- Method InteractiveFluent.TabIndex
- Method InteractiveFluent.ValidationMessage
- Extension method Outline.AddBinding
- Extension method Outline.AddBindings
- Extension method Outline.AddItem
- Extension method Outline.AddItems
- Extension method Outline.CurrentIndex
- Extension method Outline.Disabled
- Extension method Outline.Label
- Extension method Outline.TabIndex
- Extension method Outline.ValidationMessage
Constructors
public Outline(string key) #Creates an outline.
Parameters
- key string
- The application-state key; its value is the current entry's title.
Inherited Methods
public bool HandleInput(InputEvent input, RenderContext context) #Parameters
- input InputEvent
- context RenderContext
Returns
boolpublic Size Measure(Constraints constraints, RenderContext context) #Parameters
- constraints Constraints
- context RenderContext
Returns
Sizepublic void Render(Region region, RenderContext context) #Parameters
- region Region
- context RenderContext
Properties
public IList<OutlineItem> Items { get; } #The entries, in order. Configure them before the app runs.
public int CurrentIndex { get; set; } #The index of the entry the reader is on, or -1. A view that scrolls sets it to follow the reading position; the selection follows it unless the outline has focus.
Inherited Properties
Inherited Events
public event EventHandler<AppValueChangedEventArgs>? Changed #Extension Methods
public static Outline AddBinding(Outline outline, KeyBinding item) #Adds an item to InputControl.Bindings: Keys that apply while this control has focus. They reach the control before its own keys (so Enter can open the selected row) and feed the app footer.
Parameters
- outline ConsoleMonster.Interactive.Outline
- The instance.
- item ConsoleMonster.Interactive.KeyBinding
- The item.
public static Outline AddBindings(Outline outline, params KeyBinding[] items) #Adds items to InputControl.Bindings: Keys that apply while this control has focus. They reach the control before its own keys (so Enter can open the selected row) and feed the app footer.
Parameters
- outline ConsoleMonster.Interactive.Outline
- The instance.
- items ConsoleMonster.Interactive.KeyBinding[]
- The items, in order.
public static Outline AddBindings(Outline outline, IEnumerable<KeyBinding> items) #Adds items to InputControl.Bindings: Keys that apply while this control has focus. They reach the control before its own keys (so Enter can open the selected row) and feed the app footer.
Parameters
- outline ConsoleMonster.Interactive.Outline
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Interactive.KeyBinding>
- The items, in order.
public static Outline AddItem(Outline outline, OutlineItem item) #Adds an item to Outline.Items: The entries, in order. Configure them before the app runs.
Parameters
- outline ConsoleMonster.Interactive.Outline
- The instance.
- item ConsoleMonster.Interactive.OutlineItem
- The item.
public static Outline AddItems(Outline outline, params OutlineItem[] items) #Adds items to Outline.Items: The entries, in order. Configure them before the app runs.
Parameters
- outline ConsoleMonster.Interactive.Outline
- The instance.
- items ConsoleMonster.Interactive.OutlineItem[]
- The items, in order.
public static Outline AddItems(Outline outline, IEnumerable<OutlineItem> items) #Adds items to Outline.Items: The entries, in order. Configure them before the app runs.
Parameters
- outline ConsoleMonster.Interactive.Outline
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Interactive.OutlineItem>
- The items, in order.
public static Outline CurrentIndex(Outline outline, int value) #Sets Outline.CurrentIndex: The index of the entry the reader is on, or -1. A view that scrolls sets it to follow the reading position; the selection follows it unless the outline has focus.
Parameters
- outline ConsoleMonster.Interactive.Outline
- The instance.
- value int
- The value.
Examples
// C# initializer or property // C# fluent
outline.CurrentIndex = value; outline.CurrentIndex(value);public static Outline Disabled(Outline outline, bool value) #Sets InputControl.Disabled: Whether this control is excluded from input and focus traversal.
Parameters
- outline ConsoleMonster.Interactive.Outline
- The instance.
- value bool
- The value.
Examples
// C# initializer or property // C# fluent
outline.Disabled = value; outline.Disabled(value);public static Outline Disabled(Outline outline) #Sets InputControl.Disabled to true.
Parameters
- outline ConsoleMonster.Interactive.Outline
- The instance to configure.
public static Outline Label(Outline outline, string? value) #Sets InputControl.Label: The visible label, or null to use the name.
Parameters
- outline ConsoleMonster.Interactive.Outline
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
outline.Label = value; outline.Label(value);public static Outline TabIndex(Outline outline, int value) #Sets InputControl.TabIndex: Focus order; equal values preserve declaration order.
Parameters
- outline ConsoleMonster.Interactive.Outline
- The instance.
- value int
- The value.
Examples
// C# initializer or property // C# fluent
outline.TabIndex = value; outline.TabIndex(value);public static Outline ValidationMessage(Outline outline, string? value) #Sets InputControl.ValidationMessage: The current validation message below the control, or null.
Parameters
- outline ConsoleMonster.Interactive.Outline
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
outline.ValidationMessage = value; outline.ValidationMessage(value);