API Reference
ProgressColumn
One column of a progress display (Lanes.Columns, ProgressBar.Columns). Built-ins come from ProgressColumns; derive from this class, or use ProgressColumns.Custom, for your own (an icon, result counts, a phase). The same columns render in full-screen and inline sessions and feed the compact stream summary.
Inheritance
- Object
- ProgressColumn
Usage
Explore 28 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 15
- Property Lanes.Columns
- Property ProgressBar.Columns
- Method ProgressColumns.Bar
- Method ProgressColumns.Count
- Method ProgressColumns.Custom
- Method ProgressColumns.Description
- Method ProgressColumns.Elapsed
- Method ProgressColumns.FromNames
- Method ProgressColumns.Percent
- Method ProgressColumns.Rate
- Method ProgressColumns.Remaining
- Method ProgressColumns.Results
- Method ProgressColumns.Spinner
- Method ProgressColumns.Standard
- Method ProgressColumns.Status
Accepted by parameters 13
- Extension method Lanes.AddColumn
- Extension method Lanes.AddColumns
- Extension method Lanes.WithColumns
- Method LanesFluent.AddColumn
- Method LanesFluent.AddColumns
- Method LanesFluent.WithColumns
- Extension method ProgressBar.AddColumn
- Extension method ProgressBar.AddColumns
- Extension method ProgressBar.WithColumns
- Method ProgressBarFluent.AddColumn
- Method ProgressBarFluent.AddColumns
- Method ProgressBarFluent.WithColumns
- Method ProgressColumns.TryCreate
Methods
public virtual Void Draw(Region region, Int32 x, Int32 y, Int32 width, ProgressRow row, RenderContext context) #VoidDraws one row into its cell range (truncated and aligned by default).
Parameters
- region ConsoleMonster.Canvas.Region
- The region.
- x System.Int32
- The first column.
- y System.Int32
- The row.
- width System.Int32
- The width in cells.
- row ConsoleMonster.Widgets.ProgressRow
- The row.
- context ConsoleMonster.Canvas.RenderContext
- The render context.
public virtual Int32 Measure(IReadOnlyList<ProgressRow> rows, RenderContext context) #Int32The width of a fixed column: the widest row (capped by ProgressColumn.MaxWidth).
Parameters
- rows System.Collections.Generic.IReadOnlyList<ConsoleMonster.Widgets.ProgressRow>
- Every row, so the width stays stable while values change.
- context ConsoleMonster.Canvas.RenderContext
- The render context.
Returns
The width in cells.
public abstract StyledLine Render(ProgressRow row, RenderContext context) #StyledLineThe content of one row.
Parameters
- row ConsoleMonster.Widgets.ProgressRow
- The row.
- context ConsoleMonster.Canvas.RenderContext
- The render context.
Returns
The styled text.
public virtual String? Summarize(ProgressRow row, RenderContext context) #String?The column in a compact stream summary line, or null to leave it out (the bar).
Parameters
- row ConsoleMonster.Widgets.ProgressRow
- The row.
- context ConsoleMonster.Canvas.RenderContext
- The render context.
Returns
The text, or null.
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public HorizontalAlignment Alignment { get; set; } #The alignment of the text within the column.
public Int32 Priority { get; set; } #When the region is too narrow, columns with the lowest priority are dropped first.
public Int32 MaxWidth { get; set; } #The widest the column gets, or 0 for no limit.
public virtual Boolean Flexible { get; } #Whether the column takes a share of the width left over by the fixed columns (the bar, the status text).
public virtual Int32 MinWidth { get; } #The narrowest a flexible column may be before it is dropped.