Skip to content
ConsoleMonster
Class

FrameHeader

ConsoleMonster.Frames

Namespace
ConsoleMonster.Frames
Assembly
ConsoleMonster
Modifiers
sealed

The frame's title line: title, facts, a thin leader, then the worst states and the observation time.

Inheritance

  • object
  • FrameHeader

Usage

Explore 27 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.

Accepted by parameters 14

Properties

public string Title { get; set; } #

The literal title, usually the view name (Replication).

public IList<string> Facts { get; } #

Literal facts in order: scope first, then counts. Empty facts are skipped.

public IList<FrameState> States { get; } #

States; the frame sorts them worst first and drops zero counts.

public DateTimeOffset? ObservedAt { get; set; } #

When the data was observed; shown as local time, with the date when it is not today.

Extension Methods

public static FrameHeader AddFact(FrameHeader frameHeader, string item) #

Adds an item to FrameHeader.Facts: Literal facts in order: scope first, then counts. Empty facts are skipped.

Parameters

frameHeader ConsoleMonster.Frames.FrameHeader required
The instance.
item string required
The item.

Returns

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

Adds items to FrameHeader.Facts: Literal facts in order: scope first, then counts. Empty facts are skipped.

Parameters

frameHeader ConsoleMonster.Frames.FrameHeader required
The instance.
items string[] required
The items, in order.

Returns

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

Adds items to FrameHeader.Facts: Literal facts in order: scope first, then counts. Empty facts are skipped.

Parameters

frameHeader ConsoleMonster.Frames.FrameHeader required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

FrameHeader The same instance.
public static FrameHeader AddState(FrameHeader frameHeader, FrameState item) #

Adds an item to FrameHeader.States: States; the frame sorts them worst first and drops zero counts.

Parameters

frameHeader ConsoleMonster.Frames.FrameHeader required
The instance.
item ConsoleMonster.Frames.FrameState required
The item.

Returns

FrameHeader The same instance.
AddStates 2 overloads
public static FrameHeader AddStates(FrameHeader frameHeader, params FrameState[] items) #

Adds items to FrameHeader.States: States; the frame sorts them worst first and drops zero counts.

Parameters

frameHeader ConsoleMonster.Frames.FrameHeader required
The instance.
items ConsoleMonster.Frames.FrameState[] required
The items, in order.

Returns

FrameHeader The same instance.
public static FrameHeader AddStates(FrameHeader frameHeader, IEnumerable<FrameState> items) #

Adds items to FrameHeader.States: States; the frame sorts them worst first and drops zero counts.

Parameters

frameHeader ConsoleMonster.Frames.FrameHeader required
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Frames.FrameState> required
The items, in order.

Returns

FrameHeader The same instance.
public static FrameHeader ObservedAt(FrameHeader frameHeader, DateTimeOffset? value) #

Sets FrameHeader.ObservedAt: When the data was observed; shown as local time, with the date when it is not today.

Parameters

frameHeader ConsoleMonster.Frames.FrameHeader required
The instance.
value System.DateTimeOffset? required
The value.

Returns

FrameHeader The same instance.

Examples

// C# initializer or property      // C# fluent
frameHeader.ObservedAt = value;    frameHeader.ObservedAt(value);
public static FrameHeader Title(FrameHeader frameHeader, string value) #

Sets FrameHeader.Title: The literal title, usually the view name (Replication).

Parameters

frameHeader ConsoleMonster.Frames.FrameHeader required
The instance.
value string required
The value.

Returns

FrameHeader The same instance.

Examples

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