Skip to content
ConsoleMonster

API Reference

Class

WidgetLabels

Namespace ConsoleMonster.Localization
Assembly ConsoleMonster
Modifiers sealed

The built-in words that widgets render: status badges, "+3 more", "Showing 5 of 20", "done in 12s", "window too small" and the like. Each render context resolves them for its language (TerminalProfile.Language, CONSOLEMONSTER_LANGUAGE or the current UI culture); English, Polish, German, Spanish, French and Italian are built in. Assign WidgetLabels.Override to replace them everywhere, or change a property on a copy from WidgetLabels.For. Format strings take {0}, {1} placeholders.

Inheritance

  • Object
  • WidgetLabels

Usage

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

Constructors

public WidgetLabels() #

Methods

public WidgetLabels Clone() #
Returns: WidgetLabels

A copy to modify.

Returns

The copy.

public static WidgetLabels For(CultureInfo? language) #
Returns: WidgetLabels

The labels for a language (cached; unknown languages get English).

Parameters

language System.Globalization.CultureInfo? requiredposition: 0
The language, or null for LabelLanguage.Default.

Returns

The labels; don't modify the cached instance, use WidgetLabels.Clone.

public static String Format(String format, params Object?[] args) #
Returns: String

Formats a label with the invariant digits the widgets already formatted.

Parameters

format System.String requiredposition: 0
The label.
args System.Object?[] requiredposition: 1
The values.

Returns

The text.

public String StatusWord(StatusKind status) #
Returns: String

The badge word for a status.

Parameters

status ConsoleMonster.Styling.StatusKind requiredposition: 0
The status.

Returns

The word.

Properties

public static WidgetLabels? Override { get; set; } #

Labels used everywhere instead of the translated ones, or null (default) to follow the language.

public static WidgetLabels Current { get; } #

The labels for code that renders without a context (stream lines of live widgets): the ones a live session set for its render thread, otherwise WidgetLabels.For the default language.

public String StatusRun { get; set; } #

The status badge for running work.

public String StatusPass { get; set; } #

The status badge for a pass.

public String StatusFail { get; set; } #

The status badge for a failure.

public String StatusWarn { get; set; } #

The status badge for a warning.

public String StatusSkip { get; set; } #

The status badge for a skip.

public String StatusInfo { get; set; } #

The status badge for information.

public String StatusWait { get; set; } #

The status badge for pending work.

public String WaitingForWork { get; set; } #

Lanes before the first lane arrives.

public String MoreCount { get; set; } #

Rows that did not fit: +{0} more.

public String DoneCount { get; set; } #

Finished rows in a summary: {0} done.

public String QueuedCount { get; set; } #

Waiting rows in a summary: {0} queued.

public String RunningCount { get; set; } #

Running rows in a summary: {0} running.

public String FailedCount { get; set; } #

Failed rows in a summary: {0} failed.

public String Done { get; set; } #

A finished row.

public String DoneIn { get; set; } #

A finished row with its duration: done in {0}.

public String Queued { get; set; } #

A waiting row.

public String AllDoneIn { get; set; } #

Everything finished: {0} done in {1}.

public String Started { get; set; } #

A started task in stream output.

public String TookDuration { get; set; } #

A duration in stream output: in {0}.

public String StepCounts { get; set; } #

Step counts in stream output: {0} passed, {1} failed, {2} warnings.

public String SkippedCount { get; set; } #

Skipped steps in stream output: {0} skipped.

public String Phase { get; set; } #

A phase in stream output: phase {0}.

public String TimeLeft { get; set; } #

Estimated time left: {0} left.

public String PerSecond { get; set; } #

A rate: {0}/s.

public String Showing { get; set; } #

A table cut short: Showing {0} of {1}.

public String GroupOf { get; set; } #

A group heading whose rows are cut short: {0} of {1} (rows shown of the group's rows).

public String GroupsShowing { get; set; } #

The groups of a table cut short, after "Showing": {0} of {1} groups.

public String OneGroup { get; set; } #

One group, after "Showing": {0} group.

public String ManyGroups { get; set; } #

Several groups, after "Showing": {0} groups.

public String OneRecord { get; set; } #

One record (cards).

public String ManyRecords { get; set; } #

Several records (cards).

public String OneHiddenColumn { get; set; } #

One hidden column: +{0} column ({1}).

public String ManyHiddenColumns { get; set; } #

Several hidden columns: +{0} columns ({1}).

public String Total { get; set; } #

The totals row of a table.

public String Subtotal { get; set; } #

A group's subtotal row.

public String Never { get; set; } #

A date that never happened (DateTime.MinValue/MaxValue).

public String WindowTooSmall { get; set; } #

A window below the layout's minimum: window too small: {0}, needs {1}.

public String Needs { get; set; } #

The minimum size alone: needs {0}.

public String Stop { get; set; } #

The dashboard footer hint for Ctrl+C.

public String CausedBy { get; set; } #

An inner exception heading.

public String OneMoreFrame { get; set; } #

One hidden stack frame: + {0} more frame.

public String ManyMoreFrames { get; set; } #

Several hidden stack frames: + {0} more frames.

public String OneFrameworkFrame { get; set; } #

One hidden framework frame: + {0} framework frame.

public String ManyFrameworkFrames { get; set; } #

Several hidden framework frames: + {0} framework frames.

public String OneMoreLine { get; set; } #

One more line of code: + {0} more line.

public String ManyMoreLines { get; set; } #

More lines of code: + {0} more lines.

public String OneItem { get; set; } #

One item in a collection.

public String ManyItems { get; set; } #

Several items in a collection.

public String TestsTitle { get; set; } #

The test-run dashboard title.

public String TestsFinished { get; set; } #

A finished test run.

public String TestsFinishedWithFailures { get; set; } #

A test run that finished with failures.

public String TestsDiscovering { get; set; } #

A test run before the first file.

public String TestsStarting { get; set; } #

A test run between files.

public String TestsNoFailures { get; set; } #

The failure list of a clean run.

public String TestsOneMoreFailure { get; set; } #

One failure not shown: + {0} more failure.

public String TestsManyMoreFailures { get; set; } #

Failures not shown: + {0} more failures.

public String TestsNoneFinished { get; set; } #

The slowest list before any test finished.

public String TestsResultsByFile { get; set; } #

The title of the per-file summary table.

public String TestsFile { get; set; } #

The file column.

public String TestsCount { get; set; } #

The test count column.

public String TestsPassedColumn { get; set; } #

The passed column.

public String TestsFailedColumn { get; set; } #

The failed column.

public String TestsSkippedColumn { get; set; } #

The skipped column.

public String TestsTimeColumn { get; set; } #

The time column.

public String TestsFailures { get; set; } #

The failures heading.

public String TestsFailed { get; set; } #

The outcome of a failed run.

public String TestsInconclusive { get; set; } #

The outcome of an inconclusive run.

public String TestsPassed { get; set; } #

The outcome of a passed run.

public String TestsExpected { get; set; } #

The expected value of a failed assertion.

public String TestsActual { get; set; } #

The actual value of a failed assertion.

public String TestsPassedCount { get; set; } #

Passed tests: {0} passed.

public String TestsInconclusiveCount { get; set; } #

Inconclusive tests: {0} inconclusive.

public String TestsNotRunCount { get; set; } #

Tests not run: {0} not run.

public String TestsOneBlockFailed { get; set; } #

One failed block: {0} block failed.

public String TestsManyBlocksFailed { get; set; } #

Failed blocks: {0} blocks failed.

public String TestsDoneCount { get; set; } #

Tests run: {0} tests.

public String TestsDoneOfTotal { get; set; } #

Tests run of the total: {0} of {1}.

public String TestsSlowest { get; set; } #

The slowest tests panel.

public String TestsDurations { get; set; } #

The durations panel.

public String TestsFiles { get; set; } #

The files panel.

public String TestsFilesDone { get; set; } #

Files done: {0} of {1} done.

public String TestsStatusRunning { get; set; } #

The dashboard status while tests run.

public String TestsStatusFailed { get; set; } #

The dashboard status after failures.

public String TestsStatusInconclusive { get; set; } #

The dashboard status of an inconclusive run.

public String TestsStatusPassed { get; set; } #

The dashboard status of a passed run.

public String RenderError { get; set; } #

A frame that failed to render: render error at {0}: {1}.

public String ChangesAdded { get; set; } #

Added objects: +{0} added.

public String ChangesRemoved { get; set; } #

Removed objects: -{0} removed.

public String ChangesChanged { get; set; } #

Changed objects: ~{0} changed.

public String ChangesUnchanged { get; set; } #

Unchanged objects: {0} unchanged.

public String EarlierCount { get; set; } #

Items before a window: +{0} earlier.

public String WarningCount { get; set; } #

Items with a warning: {0} warnings.

public String WatchEvery { get; set; } #

The heading of a watched command: Every {0}: with the interval.

public String ChangesNotCompared { get; set; } #

Properties left out of a comparison because reading them stalled: {0} not compared.

public String ChangesItem { get; set; } #

The item column of a change table.

public String ChangesProperty { get; set; } #

The property column of a change table.

public String ChangesBefore { get; set; } #

The old value column.

public String ChangesAfter { get; set; } #

The new value column.

public String ChangesSeeDiff { get; set; } #

A long value shown as a line diff below the table.

public String ChangesNone { get; set; } #

A comparison without changes.

public String ChangesConfirm { get; set; } #

The question before applying changes.

public String Members { get; set; } #

The members of an inspected object: {0} members.

public String MoreUnknown { get; set; } #

A collection cut short without a known count.

public String MoreColumns { get; set; } #

Hidden columns of an inspected collection: +{0} more columns.