Skip to content
ConsoleMonster

API Reference

Class

Lane

Namespace ConsoleMonster.Widgets
Assembly ConsoleMonster
Source Lane.cs:95
Modifiers sealed

One row of a Lanes widget: a worker, server or item with progress and result counts.

Inheritance

  • Object
  • Lane

Usage

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

Constructors

public Lane(String key, String label) #

Creates a lane.

Parameters

key System.String requiredposition: 0
Unique key.
label System.String requiredposition: 1
Display label (plain text).

Properties

public String Key { get; } #

Unique key.

public String Label { get; set; } #

Display label (literal; setting it clears Lane.LabelText).

public RichText? LabelText { get; set; } #

A multicolour label, or null for the literal Lane.Label (which becomes its plain text).

public Double Total { get; set; } #

Planned steps (0 = unknown).

public Double Done { get; set; } #

Completed steps.

public Int32 Passed { get; set; } #

Steps that passed.

public Int32 Failed { get; set; } #

Steps that failed.

public Int32 Warned { get; set; } #

Steps with warnings.

public Int32 Skipped { get; set; } #

Steps skipped.

public StatusKind Status { get; set; } #

The lane status.

public String? Detail { get; set; } #

What the lane is doing now (current rule, step, file); literal, and setting it clears Lane.DetailText.

public RichText? DetailText { get; set; } #

A multicolour detail, or null for the literal Lane.Detail (which becomes its plain text).

public TimeSpan? Started { get; set; } #

When the lane started (session time), if it has.

public TimeSpan? Finished { get; set; } #

When the lane finished (session time), if it has.

public Int32 Order { get; set; } #

Insertion order, used to keep rows stable.

public Boolean IsFinished { get; } #

Whether the lane has finished.

public Double Fraction { get; } #

The fraction complete (0-1); finished lanes are 1.