Skip to content
ConsoleMonster
Class

OutlineInputOptions

ConsoleMonster.Interactive

Edit on GitHub
Namespace
ConsoleMonster.Interactive
Assembly
ConsoleMonster
Source
OutlineInputOptions.cs:7
Base
AppInputOptions
Modifiers
sealed

Constructs an outline using the same definition as New-ConsoleOutline.

Inheritance

Usage

Explore 44 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 19

Accepted by parameters 25

Constructors

public OutlineInputOptions() #
OutlineInputOptions.cs:7

Properties

public IList<OutlineItem> Items { get; } #
OutlineInputOptions.cs:7

The entries, in order.

public int CurrentIndex { get; set; } #
OutlineInputOptions.cs:9

The index of the entry that starts current, or -1 for none.

Extension Methods

public static OutlineInputOptions AddItem(OutlineInputOptions outlineInputOptions, OutlineItem item) #

Adds an item to OutlineInputOptions.Items: The entries, in order.

Parameters

outlineInputOptions ConsoleMonster.Interactive.OutlineInputOptions required
The instance.
item ConsoleMonster.Interactive.OutlineItem required
The item.

Returns

OutlineInputOptions The same instance.
AddItems 2 overloads
public static OutlineInputOptions AddItems(OutlineInputOptions outlineInputOptions, params OutlineItem[] items) #

Adds items to OutlineInputOptions.Items: The entries, in order.

Parameters

outlineInputOptions ConsoleMonster.Interactive.OutlineInputOptions required
The instance.
items ConsoleMonster.Interactive.OutlineItem[] required
The items, in order.

Returns

OutlineInputOptions The same instance.
public static OutlineInputOptions AddItems(OutlineInputOptions outlineInputOptions, IEnumerable<OutlineItem> items) #

Adds items to OutlineInputOptions.Items: The entries, in order.

Parameters

outlineInputOptions ConsoleMonster.Interactive.OutlineInputOptions required
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Interactive.OutlineItem> required
The items, in order.

Returns

OutlineInputOptions The same instance.
public static Outline Build(OutlineInputOptions options) #
Ui.Construction.cs:34

Materializes an outline definition.

Parameters

options ConsoleMonster.Interactive.OutlineInputOptions required
The definition.

Returns

Outline The outline.
public static OutlineInputOptions Configure(OutlineInputOptions outlineInputOptions, Action<OutlineInputOptions> configure) #

Assigns callbacks and related configuration without invoking delegate-valued properties.

Parameters

outlineInputOptions ConsoleMonster.Interactive.OutlineInputOptions required
The instance.
configure System.Action<ConsoleMonster.Interactive.OutlineInputOptions> required
Assignments applied in order.

Returns

OutlineInputOptions The same instance.

Examples

// C# initializer or property                                                       // C# fluent
new global::ConsoleMonster.Interactive.OutlineInputOptions { OnChange = value };    Ui.Outline().Configure(configured => configured.OnChange = value);
public static OutlineInputOptions CurrentIndex(OutlineInputOptions outlineInputOptions, int value) #

Sets OutlineInputOptions.CurrentIndex: The index of the entry that starts current, or -1 for none.

Parameters

outlineInputOptions ConsoleMonster.Interactive.OutlineInputOptions required
The instance.
value int required
The value.

Returns

OutlineInputOptions The same instance.

Examples

// C# initializer or property                                                           // C# fluent
new global::ConsoleMonster.Interactive.OutlineInputOptions { CurrentIndex = value };    Ui.Outline().CurrentIndex(value);
Disabled 2 overloads
public static OutlineInputOptions Disabled(OutlineInputOptions outlineInputOptions, bool value) #

Sets AppInputOptions.Disabled: Disables editing and keyboard focus.

Parameters

outlineInputOptions ConsoleMonster.Interactive.OutlineInputOptions required
The instance.
value bool required
The value.

Returns

OutlineInputOptions The same instance.

Examples

// C# initializer or property                                                       // C# fluent
new global::ConsoleMonster.Interactive.OutlineInputOptions { Disabled = value };    Ui.Outline().Disabled(value);
public static OutlineInputOptions Disabled(OutlineInputOptions outlineInputOptions) #

Sets AppInputOptions.Disabled to true.

Parameters

outlineInputOptions ConsoleMonster.Interactive.OutlineInputOptions required
The instance to configure.

Returns

OutlineInputOptions The same instance.
public static OutlineInputOptions Key(OutlineInputOptions outlineInputOptions, string value) #

Sets AppInputOptions.Key: The unique application-state key.

Parameters

outlineInputOptions ConsoleMonster.Interactive.OutlineInputOptions required
The instance.
value string required
The value.

Returns

OutlineInputOptions The same instance.

Examples

// C# initializer or property                                                  // C# fluent
new global::ConsoleMonster.Interactive.OutlineInputOptions { Key = value };    Ui.Outline().Key(value);
public static OutlineInputOptions Label(OutlineInputOptions outlineInputOptions, string? value) #

Sets AppInputOptions.Label: The visible label; null uses the key.

Parameters

outlineInputOptions ConsoleMonster.Interactive.OutlineInputOptions required
The instance.
value string? required
The value.

Returns

OutlineInputOptions The same instance.

Examples

// C# initializer or property                                                    // C# fluent
new global::ConsoleMonster.Interactive.OutlineInputOptions { Label = value };    Ui.Outline().Label(value);
public static OutlineInputOptions TabIndex(OutlineInputOptions outlineInputOptions, int value) #

Sets AppInputOptions.TabIndex: Keyboard focus order; equal values preserve declaration order.

Parameters

outlineInputOptions ConsoleMonster.Interactive.OutlineInputOptions required
The instance.
value int required
The value.

Returns

OutlineInputOptions The same instance.

Examples

// C# initializer or property                                                       // C# fluent
new global::ConsoleMonster.Interactive.OutlineInputOptions { TabIndex = value };    Ui.Outline().TabIndex(value);
public static OutlineInputOptions ValidationMessage(OutlineInputOptions outlineInputOptions, string? value) #

Sets AppInputOptions.ValidationMessage: Initial validation text.

Parameters

outlineInputOptions ConsoleMonster.Interactive.OutlineInputOptions required
The instance.
value string? required
The value.

Returns

OutlineInputOptions The same instance.

Examples

// C# initializer or property                                                                // C# fluent
new global::ConsoleMonster.Interactive.OutlineInputOptions { ValidationMessage = value };    Ui.Outline().ValidationMessage(value);