Skip to content
ConsoleMonster

API Reference

Class

SummaryBarHandle

Edit on GitHub
Namespace ConsoleMonster.Widgets
Assembly ConsoleMonster
Source SummaryBarHandle.cs:10
Base LiveHandle
Modifiers sealed

Thread-safe updates for a SummaryBar through its session's dispatcher.

Inheritance

Usage

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

Constructors

public SummaryBarHandle(ILiveDispatcher dispatcher, String target) #
SummaryBarHandle.cs:10

Creates a summary-bar handle.

Parameters

dispatcher ConsoleMonster.Live.ILiveDispatcher requiredposition: 0
The dispatcher.
target System.String requiredposition: 1
The summary bar's name.

Methods

public Void SetCounter(String label, Int32 count, StatusKind? status = null) #
SummaryBarHandle.cs:21
Returns: Void

Adds or replaces a named counter in apply order.

Parameters

label System.String requiredposition: 0
The nonempty counter label, optionally containing a {0} count placeholder.
count System.Int32 requiredposition: 1
The count.
status ConsoleMonster.Styling.StatusKind? = null optionalposition: 2
The status for its marker and tone, or null to retain the existing status.
public Void SetProgress(Double done = -1, Double total = -1) #
SummaryBarHandle.cs:15
Returns: Void

Sets progress; a kept value uses the preceding queued update, not a producer's stale copy.

Parameters

done System.Double = -1 optionalposition: 0
Items completed, or SummaryBar.Keep to leave the value unchanged.
total System.Double = -1 optionalposition: 1
Total items, or SummaryBar.Keep to leave it unchanged.