Skip to content
ConsoleMonster
Class

ProgressOptionsFluent

ConsoleMonster.Widgets

Namespace
ConsoleMonster.Widgets
Assembly
ConsoleMonster
Modifiers
static
Attributes
GeneratedCode("ConsoleMonster.Generators", "1.0.0")

The fluent methods of ProgressOptions, generated from its public properties: A property-named method sets a property and Add... adds to a collection, both returning the same instance.

Inheritance

  • object
  • ProgressOptionsFluent

Methods

public static ProgressOptions AddColumn(ProgressOptions progressOptions, ProgressColumn item) #

Adds an item to ProgressOptions.Columns: The ordered progress columns.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
item ConsoleMonster.Widgets.ProgressColumn required
The item.

Returns

ProgressOptions The same instance.
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 required
The instance.
items ConsoleMonster.Widgets.ProgressColumn[] required
The items, in order.

Returns

ProgressOptions The same instance.
public static ProgressOptions AddColumns(ProgressOptions progressOptions, IEnumerable<ProgressColumn> items) #

Adds items to ProgressOptions.Columns: The ordered progress columns.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Widgets.ProgressColumn> required
The items, in order.

Returns

ProgressOptions The same instance.
public static ProgressOptions Columns(ProgressOptions progressOptions, IList<ProgressColumn>? value) #

Sets ProgressOptions.Columns: The ordered progress columns.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
value System.Collections.Generic.IList<ConsoleMonster.Widgets.ProgressColumn>? required
The value.

Returns

ProgressOptions The same instance.

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 required
The instance.
value ConsoleMonster.Layout.ColumnFormat? required
The value.

Returns

ProgressOptions The same instance.

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 required
The instance.
configure System.Action<ConsoleMonster.Layout.ColumnFormat> required
Configures the value.

Returns

ProgressOptions The same instance.
public static ProgressOptions Detail(ProgressOptions progressOptions, string? value) #

Sets ProgressOptions.Detail: The indeterminate indicator detail.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
value string? required
The value.

Returns

ProgressOptions The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { Detail = value };    Ui.Progress().Detail(value);
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 required
The instance.
value System.TimeSpan? required
The value.

Returns

ProgressOptions The same instance.

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 required
The instance.
value bool required
The value.

Returns

ProgressOptions The same instance.

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 required
The instance to configure.

Returns

ProgressOptions The same instance.
public static ProgressOptions Label(ProgressOptions progressOptions, string value) #

Sets ProgressOptions.Label: The label, including supported markup.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
value string required
The value.

Returns

ProgressOptions The same instance.

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 required
The instance.
value int? required
The value.

Returns

ProgressOptions The same instance.

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 required
The instance.
value System.TimeSpan required
The value.

Returns

ProgressOptions The same instance.

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 required
The instance.
value ConsoleMonster.Widgets.BarShape required
The value.

Returns

ProgressOptions The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { Shape = value };    Ui.Progress().Shape(value);
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 required
The instance.
value bool required
The value.

Returns

ProgressOptions The same instance.

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 required
The instance to configure.

Returns

ProgressOptions The same instance.
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 required
The instance.
value bool required
The value.

Returns

ProgressOptions The same instance.

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 required
The instance to configure.

Returns

ProgressOptions The same instance.
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 required
The instance.
value System.TimeSpan? required
The value.

Returns

ProgressOptions The same instance.

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 required
The instance.
value ConsoleMonster.Styling.StatusKind required
The value.

Returns

ProgressOptions The same instance.

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 required
The instance.
value double required
The value.

Returns

ProgressOptions The same instance.

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 required
The instance.
value double required
The value.

Returns

ProgressOptions The same instance.

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 required
The instance.
value string? required
The value.

Returns

ProgressOptions The same instance.

Examples

// C# initializer or property                                               // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { WidgetId = value };    Ui.Progress().WidgetId(value);