Skip to content
ConsoleMonster
Class

BreadcrumbInputOptions

ConsoleMonster.Interactive

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

Constructs a breadcrumb using the same definition as New-ConsoleBreadcrumb.

Inheritance

Usage

Explore 52 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

Accepted by parameters 29

Constructors

public BreadcrumbInputOptions() #
BreadcrumbInputOptions.cs:7

Properties

public IList<string> Segments { get; } #
BreadcrumbInputOptions.cs:7

The segments, outermost first, shown when no outline is followed.

public IList<string> Ancestors { get; } #
BreadcrumbInputOptions.cs:9

Segments shown before a followed outline's headings.

public Outline? Outline { get; set; } #
BreadcrumbInputOptions.cs:11

The outline whose current entry the breadcrumb shows, or null.

Extension Methods

public static BreadcrumbInputOptions AddAncestor(BreadcrumbInputOptions breadcrumbInputOptions, string item) #

Adds an item to BreadcrumbInputOptions.Ancestors: Segments shown before a followed outline's headings.

Parameters

breadcrumbInputOptions ConsoleMonster.Interactive.BreadcrumbInputOptions required
The instance.
item string required
The item.

Returns

BreadcrumbInputOptions The same instance.
AddAncestors 2 overloads
public static BreadcrumbInputOptions AddAncestors(BreadcrumbInputOptions breadcrumbInputOptions, params string[] items) #

Adds items to BreadcrumbInputOptions.Ancestors: Segments shown before a followed outline's headings.

Parameters

breadcrumbInputOptions ConsoleMonster.Interactive.BreadcrumbInputOptions required
The instance.
items string[] required
The items, in order.

Returns

BreadcrumbInputOptions The same instance.
public static BreadcrumbInputOptions AddAncestors(BreadcrumbInputOptions breadcrumbInputOptions, IEnumerable<string> items) #

Adds items to BreadcrumbInputOptions.Ancestors: Segments shown before a followed outline's headings.

Parameters

breadcrumbInputOptions ConsoleMonster.Interactive.BreadcrumbInputOptions required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

BreadcrumbInputOptions The same instance.
public static BreadcrumbInputOptions AddSegment(BreadcrumbInputOptions breadcrumbInputOptions, string item) #

Adds an item to BreadcrumbInputOptions.Segments: The segments, outermost first, shown when no outline is followed.

Parameters

breadcrumbInputOptions ConsoleMonster.Interactive.BreadcrumbInputOptions required
The instance.
item string required
The item.

Returns

BreadcrumbInputOptions The same instance.
AddSegments 2 overloads
public static BreadcrumbInputOptions AddSegments(BreadcrumbInputOptions breadcrumbInputOptions, params string[] items) #

Adds items to BreadcrumbInputOptions.Segments: The segments, outermost first, shown when no outline is followed.

Parameters

breadcrumbInputOptions ConsoleMonster.Interactive.BreadcrumbInputOptions required
The instance.
items string[] required
The items, in order.

Returns

BreadcrumbInputOptions The same instance.
public static BreadcrumbInputOptions AddSegments(BreadcrumbInputOptions breadcrumbInputOptions, IEnumerable<string> items) #

Adds items to BreadcrumbInputOptions.Segments: The segments, outermost first, shown when no outline is followed.

Parameters

breadcrumbInputOptions ConsoleMonster.Interactive.BreadcrumbInputOptions required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

BreadcrumbInputOptions The same instance.
public static Breadcrumb Build(BreadcrumbInputOptions options) #
Ui.Construction.cs:39

Materializes a breadcrumb definition.

Parameters

options ConsoleMonster.Interactive.BreadcrumbInputOptions required
The definition.

Returns

Breadcrumb The breadcrumb.
public static BreadcrumbInputOptions Configure(BreadcrumbInputOptions breadcrumbInputOptions, Action<BreadcrumbInputOptions> configure) #

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

Parameters

breadcrumbInputOptions ConsoleMonster.Interactive.BreadcrumbInputOptions required
The instance.
configure System.Action<ConsoleMonster.Interactive.BreadcrumbInputOptions> required
Assignments applied in order.

Returns

BreadcrumbInputOptions The same instance.

Examples

// C# initializer or property                                                          // C# fluent
new global::ConsoleMonster.Interactive.BreadcrumbInputOptions { OnChange = value };    Ui.Breadcrumb().Configure(configured => configured.OnChange = value);
Disabled 2 overloads
public static BreadcrumbInputOptions Disabled(BreadcrumbInputOptions breadcrumbInputOptions, bool value) #

Sets AppInputOptions.Disabled: Disables editing and keyboard focus.

Parameters

breadcrumbInputOptions ConsoleMonster.Interactive.BreadcrumbInputOptions required
The instance.
value bool required
The value.

Returns

BreadcrumbInputOptions The same instance.

Examples

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

Sets AppInputOptions.Disabled to true.

Parameters

breadcrumbInputOptions ConsoleMonster.Interactive.BreadcrumbInputOptions required
The instance to configure.

Returns

BreadcrumbInputOptions The same instance.
public static BreadcrumbInputOptions Key(BreadcrumbInputOptions breadcrumbInputOptions, string value) #

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

Parameters

breadcrumbInputOptions ConsoleMonster.Interactive.BreadcrumbInputOptions required
The instance.
value string required
The value.

Returns

BreadcrumbInputOptions The same instance.

Examples

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

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

Parameters

breadcrumbInputOptions ConsoleMonster.Interactive.BreadcrumbInputOptions required
The instance.
value string? required
The value.

Returns

BreadcrumbInputOptions The same instance.

Examples

// C# initializer or property                                                       // C# fluent
new global::ConsoleMonster.Interactive.BreadcrumbInputOptions { Label = value };    Ui.Breadcrumb().Label(value);
Outline 2 overloads
public static BreadcrumbInputOptions Outline(BreadcrumbInputOptions breadcrumbInputOptions, Outline? value) #

Sets BreadcrumbInputOptions.Outline: The outline whose current entry the breadcrumb shows, or null.

Parameters

breadcrumbInputOptions ConsoleMonster.Interactive.BreadcrumbInputOptions required
The instance.
value ConsoleMonster.Interactive.Outline? required
The value.

Returns

BreadcrumbInputOptions The same instance.

Examples

// C# initializer or property                                                         // C# fluent
new global::ConsoleMonster.Interactive.BreadcrumbInputOptions { Outline = value };    Ui.Breadcrumb().Outline(value);
public static BreadcrumbInputOptions Outline(BreadcrumbInputOptions breadcrumbInputOptions, Action<Outline> configure) #

Configures BreadcrumbInputOptions.Outline in place: The outline whose current entry the breadcrumb shows, or null.

Parameters

breadcrumbInputOptions ConsoleMonster.Interactive.BreadcrumbInputOptions required
The instance.
configure System.Action<ConsoleMonster.Interactive.Outline> required
Configures the value.

Returns

BreadcrumbInputOptions The same instance.
public static BreadcrumbInputOptions TabIndex(BreadcrumbInputOptions breadcrumbInputOptions, int value) #

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

Parameters

breadcrumbInputOptions ConsoleMonster.Interactive.BreadcrumbInputOptions required
The instance.
value int required
The value.

Returns

BreadcrumbInputOptions The same instance.

Examples

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

Sets AppInputOptions.ValidationMessage: Initial validation text.

Parameters

breadcrumbInputOptions ConsoleMonster.Interactive.BreadcrumbInputOptions required
The instance.
value string? required
The value.

Returns

BreadcrumbInputOptions The same instance.

Examples

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