Skip to content
ConsoleMonster
Class

ViewHeader

ConsoleMonster.Widgets

Edit on GitHub
Namespace
ConsoleMonster.Widgets
Assembly
ConsoleMonster
Source
ViewHeader.cs:22
Implements
IWidget
Modifiers
sealed

A title and facts joined by a thin leader to a right-aligned state.

Inheritance

  • object
  • ViewHeader

Usage

Explore 24 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 11

Accepted by parameters 13

Constructors

public ViewHeader(string title, string? state = null, params string[] facts) #
ViewHeader.cs:22

Creates a header. The title is literal text; facts and state accept markup.

Parameters

title string required
state string? = null optional
facts string[] required

Methods

public int CompactWidth(int available, RenderContext context) #
ViewHeader.cs:30

Natural compact width when the full title/facts/state line cannot fit.

Parameters

available int required
context ConsoleMonster.Canvas.RenderContext required

Returns

int
public Size Measure(Constraints constraints, RenderContext context) #
ViewHeader.cs:38

Returns the size the widget wants within the constraints.

Parameters

constraints ConsoleMonster.Layout.Constraints required
The space offered.
context ConsoleMonster.Canvas.RenderContext required
Profile, theme and glyphs.

Returns

Size The desired size, never larger than the constraints.
public int NaturalWidth(RenderContext context) #
ViewHeader.cs:26

The natural width before applying the compact title layout.

Parameters

context ConsoleMonster.Canvas.RenderContext required

Returns

int
public void Render(Region region, RenderContext context) #
ViewHeader.cs:45

Renders into a region. The region may be smaller or larger than the measured size.

Parameters

region ConsoleMonster.Canvas.Region required
The target region.
context ConsoleMonster.Canvas.RenderContext required
Profile, theme and glyphs.

Properties

public string Title { get; set; } #
ViewHeader.cs:18

The literal title.

public string State { get; set; } #
ViewHeader.cs:20

State markup, including an optional observation time.

public IList<string> Facts { get; } #
ViewHeader.cs:22

Fact markup, joined only at separators.

public bool Streaming { get; set; } #
ViewHeader.cs:24

Whether the header describes an open stream, whose verdict is not known yet.

Extension Methods

public static ViewHeader AddFact(ViewHeader viewHeader, string item) #

Adds an item to ViewHeader.Facts: Fact markup, joined only at separators.

Parameters

viewHeader ConsoleMonster.Widgets.ViewHeader required
The instance.
item string required
The item.

Returns

ViewHeader The same instance.
AddFacts 2 overloads
public static ViewHeader AddFacts(ViewHeader viewHeader, params string[] items) #

Adds items to ViewHeader.Facts: Fact markup, joined only at separators.

Parameters

viewHeader ConsoleMonster.Widgets.ViewHeader required
The instance.
items string[] required
The items, in order.

Returns

ViewHeader The same instance.
public static ViewHeader AddFacts(ViewHeader viewHeader, IEnumerable<string> items) #

Adds items to ViewHeader.Facts: Fact markup, joined only at separators.

Parameters

viewHeader ConsoleMonster.Widgets.ViewHeader required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

ViewHeader The same instance.
public static ViewHeader State(ViewHeader viewHeader, string value) #

Sets ViewHeader.State: State markup, including an optional observation time.

Parameters

viewHeader ConsoleMonster.Widgets.ViewHeader required
The instance.
value string required
The value.

Returns

ViewHeader The same instance.

Examples

// C# initializer or property    // C# fluent
viewHeader.State = value;        viewHeader.State(value);
Streaming 2 overloads
public static ViewHeader Streaming(ViewHeader viewHeader, bool value) #

Sets ViewHeader.Streaming: Whether the header describes an open stream, whose verdict is not known yet.

Parameters

viewHeader ConsoleMonster.Widgets.ViewHeader required
The instance.
value bool required
The value.

Returns

ViewHeader The same instance.

Examples

// C# initializer or property    // C# fluent
viewHeader.Streaming = value;    viewHeader.Streaming(value);
public static ViewHeader Streaming(ViewHeader viewHeader) #

Sets ViewHeader.Streaming to true.

Parameters

viewHeader ConsoleMonster.Widgets.ViewHeader required
The instance to configure.

Returns

ViewHeader The same instance.
public static ViewHeader Title(ViewHeader viewHeader, string value) #

Sets ViewHeader.Title: The literal title.

Parameters

viewHeader ConsoleMonster.Widgets.ViewHeader required
The instance.
value string required
The value.

Returns

ViewHeader The same instance.

Examples

// C# initializer or property    // C# fluent
viewHeader.Title = value;        viewHeader.Title(value);