Class
ProgressOptions
ConsoleMonster.Widgets
Shared construction options for known-total and indeterminate progress indicators.
Inheritance
- object
- ProgressOptions
Usage
Explore 84 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 37
- Method Ui.Progress
- Extension method ProgressOptions.AddColumn
- Extension method ProgressOptions.AddColumns
- Extension method ProgressOptions.Columns
- Extension method ProgressOptions.CountColumn
- Extension method ProgressOptions.Detail
- Extension method ProgressOptions.Finished
- Extension method ProgressOptions.Indeterminate
- Extension method ProgressOptions.Label
- Extension method ProgressOptions.LabelWidth
- Extension method ProgressOptions.RateWindow
- Extension method ProgressOptions.Shape
- Extension method ProgressOptions.ShowCount
- Extension method ProgressOptions.ShowElapsed
- Extension method ProgressOptions.Started
- Extension method ProgressOptions.Status
- Extension method ProgressOptions.Total
- Extension method ProgressOptions.Value
- Extension method ProgressOptions.WidgetId
- Method ProgressOptionsFluent.AddColumn
- Method ProgressOptionsFluent.AddColumns
- Method ProgressOptionsFluent.Columns
- Method ProgressOptionsFluent.CountColumn
- Method ProgressOptionsFluent.Detail
- Method ProgressOptionsFluent.Finished
- Method ProgressOptionsFluent.Indeterminate
- Method ProgressOptionsFluent.Label
- Method ProgressOptionsFluent.LabelWidth
- Method ProgressOptionsFluent.RateWindow
- Method ProgressOptionsFluent.Shape
- Method ProgressOptionsFluent.ShowCount
- Method ProgressOptionsFluent.ShowElapsed
- Method ProgressOptionsFluent.Started
- Method ProgressOptionsFluent.Status
- Method ProgressOptionsFluent.Total
- Method ProgressOptionsFluent.Value
- Method ProgressOptionsFluent.WidgetId
Accepted by parameters 47
- Method ContentBuilder.Progress
- Method ContentBuilder.Progress
- Method UiConstruction.Build
- Method UiConstruction.Build``1
- Method UiConstruction.Export
- Method UiConstruction.Show
- Method Progress.Create
- Extension method ProgressOptions.AddColumn
- Extension method ProgressOptions.AddColumns
- Extension method ProgressOptions.Build
- Extension method ProgressOptions.Build``1
- Extension method ProgressOptions.Columns
- Extension method ProgressOptions.CountColumn
- Extension method ProgressOptions.Detail
- Extension method ProgressOptions.Export
- Extension method ProgressOptions.Finished
- Extension method ProgressOptions.Indeterminate
- Extension method ProgressOptions.Label
- Extension method ProgressOptions.LabelWidth
- Extension method ProgressOptions.RateWindow
- Extension method ProgressOptions.Shape
- Extension method ProgressOptions.Show
- Extension method ProgressOptions.ShowCount
- Extension method ProgressOptions.ShowElapsed
- Extension method ProgressOptions.Started
- Extension method ProgressOptions.Status
- Extension method ProgressOptions.Total
- Extension method ProgressOptions.Value
- Extension method ProgressOptions.WidgetId
- Method ProgressOptionsFluent.AddColumn
- Method ProgressOptionsFluent.AddColumns
- Method ProgressOptionsFluent.Columns
- Method ProgressOptionsFluent.CountColumn
- Method ProgressOptionsFluent.Detail
- Method ProgressOptionsFluent.Finished
- Method ProgressOptionsFluent.Indeterminate
- Method ProgressOptionsFluent.Label
- Method ProgressOptionsFluent.LabelWidth
- Method ProgressOptionsFluent.RateWindow
- Method ProgressOptionsFluent.Shape
- Method ProgressOptionsFluent.ShowCount
- Method ProgressOptionsFluent.ShowElapsed
- Method ProgressOptionsFluent.Started
- Method ProgressOptionsFluent.Status
- Method ProgressOptionsFluent.Total
- Method ProgressOptionsFluent.Value
- Method ProgressOptionsFluent.WidgetId
Constructors
public ProgressOptions() #Inherited Methods
Properties
public bool Indeterminate { get; set; } #Creates an indicator for work without a known total.
public string? WidgetId { get; set; } #The live identifier; omitted uses progress or spinner.
public IList<ProgressColumn>? Columns { get; set; } #The ordered progress columns.
public bool ShowCount { get; set; } #Whether the default bar layout shows its count.
public TimeSpan RateWindow { get; set; } #The smoothing interval for rate and remaining time.
public bool ShowElapsed { get; set; } #Whether an indeterminate indicator shows elapsed time.
public TimeSpan? Started { get; set; } #Initial indeterminate start time on the session clock; null leaves it unstarted.
public TimeSpan? Finished { get; set; } #Initial indeterminate completion time on the session clock; null leaves it unfinished.
Extension Methods
public static ProgressOptions AddColumn(ProgressOptions progressOptions, ProgressColumn item) #Adds an item to ProgressOptions.Columns: The ordered progress columns.
Parameters
- progressOptions ConsoleMonster.Widgets.ProgressOptions
- The instance.
- item ConsoleMonster.Widgets.ProgressColumn
- The item.
AddColumns 2 overloads
public static ProgressOptions AddColumns(ProgressOptions progressOptions, params ProgressColumn[] items) #Adds items to ProgressOptions.Columns: The ordered progress columns.
Parameters
- progressOptions ConsoleMonster.Widgets.ProgressOptions
- The instance.
- items ConsoleMonster.Widgets.ProgressColumn[]
- The items, in order.
public static ProgressOptions AddColumns(ProgressOptions progressOptions, IEnumerable<ProgressColumn> items) #Adds items to ProgressOptions.Columns: The ordered progress columns.
Parameters
- progressOptions ConsoleMonster.Widgets.ProgressOptions
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Widgets.ProgressColumn>
- The items, in order.
public static IWidget Build(ProgressOptions options) #Creates determinate or indeterminate progress through the shared validated factory.
Parameters
- options ConsoleMonster.Widgets.ProgressOptions
- The configured definition.
public static T Build<T>(ProgressOptions options) #Materializes progress and verifies the concrete handle type.
Type Parameters
- T
- The expected renderer.
Parameters
- options ConsoleMonster.Widgets.ProgressOptions
- The definition.
Returns
T The typed renderer.public static ProgressOptions Columns(ProgressOptions progressOptions, IList<ProgressColumn>? value) #Sets ProgressOptions.Columns: The ordered progress columns.
Parameters
- progressOptions ConsoleMonster.Widgets.ProgressOptions
- The instance.
- value System.Collections.Generic.IList<ConsoleMonster.Widgets.ProgressColumn>?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { Columns = value }; Ui.Progress().Columns(value);CountColumn 2 overloads
public static ProgressOptions CountColumn(ProgressOptions progressOptions, ColumnFormat? value) #Sets ProgressOptions.CountColumn: The numeric count format.
Parameters
- progressOptions ConsoleMonster.Widgets.ProgressOptions
- The instance.
- value ConsoleMonster.Layout.ColumnFormat?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { CountColumn = value }; Ui.Progress().CountColumn(value);public static ProgressOptions CountColumn(ProgressOptions progressOptions, Action<ColumnFormat> configure) #Configures ProgressOptions.CountColumn in place: The numeric count format.
Parameters
- progressOptions ConsoleMonster.Widgets.ProgressOptions
- The instance.
- configure System.Action<ConsoleMonster.Layout.ColumnFormat>
- Configures the value.
public static ProgressOptions Detail(ProgressOptions progressOptions, string? value) #Sets ProgressOptions.Detail: The indeterminate indicator detail.
Parameters
- progressOptions ConsoleMonster.Widgets.ProgressOptions
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { Detail = value }; Ui.Progress().Detail(value);public static void Export(ProgressOptions definition, string path, string? format = null, ExportOptions? options = null, IFrameExportProvider? provider = null) #Exports the configured definition through the shared core/add-on dispatcher.
Parameters
- definition ConsoleMonster.Widgets.ProgressOptions
- The configured definition.
- path string
- The destination.
- format string? = null
- The format.
- options ConsoleMonster.Export.ExportOptions? = null
- The export options.
- provider ConsoleMonster.Export.IFrameExportProvider? = null
- An optional add-on provider.
public static ProgressOptions Finished(ProgressOptions progressOptions, TimeSpan? value) #Sets ProgressOptions.Finished: Initial indeterminate completion time on the session clock; null leaves it unfinished.
Parameters
- progressOptions ConsoleMonster.Widgets.ProgressOptions
- The instance.
- value System.TimeSpan?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { Finished = value }; Ui.Progress().Finished(value);Indeterminate 2 overloads
public static ProgressOptions Indeterminate(ProgressOptions progressOptions, bool value) #Sets ProgressOptions.Indeterminate: Creates an indicator for work without a known total.
Parameters
- progressOptions ConsoleMonster.Widgets.ProgressOptions
- The instance.
- value bool
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { Indeterminate = value }; Ui.Progress().Indeterminate(value);public static ProgressOptions Indeterminate(ProgressOptions progressOptions) #Sets ProgressOptions.Indeterminate to true.
Parameters
- progressOptions ConsoleMonster.Widgets.ProgressOptions
- The instance to configure.
public static ProgressOptions Label(ProgressOptions progressOptions, string value) #Sets ProgressOptions.Label: The label, including supported markup.
Parameters
- progressOptions ConsoleMonster.Widgets.ProgressOptions
- The instance.
- value string
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { Label = value }; Ui.Progress().Label(value);public static ProgressOptions LabelWidth(ProgressOptions progressOptions, int? value) #Sets ProgressOptions.LabelWidth: The fixed label width, when supplied.
Parameters
- progressOptions ConsoleMonster.Widgets.ProgressOptions
- The instance.
- value int?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { LabelWidth = value }; Ui.Progress().LabelWidth(value);public static ProgressOptions RateWindow(ProgressOptions progressOptions, TimeSpan value) #Sets ProgressOptions.RateWindow: The smoothing interval for rate and remaining time.
Parameters
- progressOptions ConsoleMonster.Widgets.ProgressOptions
- The instance.
- value System.TimeSpan
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { RateWindow = value }; Ui.Progress().RateWindow(value);public static ProgressOptions Shape(ProgressOptions progressOptions, BarShape value) #Sets ProgressOptions.Shape: The bar shape.
Parameters
- progressOptions ConsoleMonster.Widgets.ProgressOptions
- The instance.
- value ConsoleMonster.Widgets.BarShape
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { Shape = value }; Ui.Progress().Shape(value);public static void Show(ProgressOptions definition, TerminalProfile? profile = null, ITerminalWriter? writer = null) #Displays the configured definition through the shared widget pipeline.
Parameters
- definition ConsoleMonster.Widgets.ProgressOptions
- The configured definition.
- profile ConsoleMonster.Capabilities.TerminalProfile? = null
- The terminal profile.
- writer ConsoleMonster.Output.ITerminalWriter? = null
- The output writer.
ShowCount 2 overloads
public static ProgressOptions ShowCount(ProgressOptions progressOptions, bool value) #Sets ProgressOptions.ShowCount: Whether the default bar layout shows its count.
Parameters
- progressOptions ConsoleMonster.Widgets.ProgressOptions
- The instance.
- value bool
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { ShowCount = value }; Ui.Progress().ShowCount(value);public static ProgressOptions ShowCount(ProgressOptions progressOptions) #Sets ProgressOptions.ShowCount to true.
Parameters
- progressOptions ConsoleMonster.Widgets.ProgressOptions
- The instance to configure.
ShowElapsed 2 overloads
public static ProgressOptions ShowElapsed(ProgressOptions progressOptions, bool value) #Sets ProgressOptions.ShowElapsed: Whether an indeterminate indicator shows elapsed time.
Parameters
- progressOptions ConsoleMonster.Widgets.ProgressOptions
- The instance.
- value bool
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { ShowElapsed = value }; Ui.Progress().ShowElapsed(value);public static ProgressOptions ShowElapsed(ProgressOptions progressOptions) #Sets ProgressOptions.ShowElapsed to true.
Parameters
- progressOptions ConsoleMonster.Widgets.ProgressOptions
- The instance to configure.
public static ProgressOptions Started(ProgressOptions progressOptions, TimeSpan? value) #Sets ProgressOptions.Started: Initial indeterminate start time on the session clock; null leaves it unstarted.
Parameters
- progressOptions ConsoleMonster.Widgets.ProgressOptions
- The instance.
- value System.TimeSpan?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { Started = value }; Ui.Progress().Started(value);public static ProgressOptions Status(ProgressOptions progressOptions, StatusKind value) #Sets ProgressOptions.Status: The initial state.
Parameters
- progressOptions ConsoleMonster.Widgets.ProgressOptions
- The instance.
- value ConsoleMonster.Styling.StatusKind
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { Status = value }; Ui.Progress().Status(value);public static ProgressOptions Total(ProgressOptions progressOptions, double value) #Sets ProgressOptions.Total: The planned total.
Parameters
- progressOptions ConsoleMonster.Widgets.ProgressOptions
- The instance.
- value double
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { Total = value }; Ui.Progress().Total(value);public static ProgressOptions Value(ProgressOptions progressOptions, double value) #Sets ProgressOptions.Value: The initial completed value.
Parameters
- progressOptions ConsoleMonster.Widgets.ProgressOptions
- The instance.
- value double
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { Value = value }; Ui.Progress().Value(value);public static ProgressOptions WidgetId(ProgressOptions progressOptions, string? value) #Sets ProgressOptions.WidgetId: The live identifier; omitted uses progress or spinner.
Parameters
- progressOptions ConsoleMonster.Widgets.ProgressOptions
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { WidgetId = value }; Ui.Progress().WidgetId(value);