Spectre.Console

ProgressExtensions

Contains extension methods for .

Contains extension methods for Progress.

Methods

public static Progress AutoClear(Progress progress, bool enabled)

Sets whether or not auto clear is enabled. If enabled, the task tabled will be removed once all tasks have completed.

Parameters:

progress (Progress)
The Progress instance.
enabled (bool)
Whether or not auto clear is enabled.

Returns:

The same instance so that multiple calls can be chained.

public static Progress AutoRefresh(Progress progress, bool enabled)

Sets whether or not auto refresh is enabled. If disabled, you will manually have to refresh the progress.

Parameters:

progress (Progress)
The Progress instance.
enabled (bool)
Whether or not auto refresh is enabled.

Returns:

The same instance so that multiple calls can be chained.

public static Progress Columns(Progress progress, ProgressColumn[] columns)

Sets the columns to be used for an Progress instance.

Parameters:

progress (Progress)
The Progress instance.
columns (ProgressColumn[])
The columns to use.

Returns:

The same instance so that multiple calls can be chained.

public static Progress ExcludeVerticalPadding(Progress progress, bool enabled)

Sets whether or not to exclude the vertical padding in the display. If enabled, the progress display will not include vertical padding.

Parameters:

progress (Progress)
The Progress instance.
enabled (bool)
Whether or not to exclude the vertical padding.

Returns:

The same instance so that multiple calls can be chained.

public static Progress ExcludeVerticalPadding(Progress progress)

Excludes the vertical padding in the display.

Parameters:

progress (Progress)
The Progress instance.

Returns:

The same instance so that multiple calls can be chained.

public static Progress HideCompleted(Progress progress, bool enabled)

Sets whether or not hide completed is enabled. If enabled, the task tabled will be removed once it is completed.

Parameters:

progress (Progress)
The Progress instance.
enabled (bool)
Whether or not hide completed is enabled.

Returns:

The same instance so that multiple calls can be chained.

public static Progress IncludeVerticalPadding(Progress progress)

Includes the vertical padding in the display.

Parameters:

progress (Progress)
The Progress instance.

Returns:

The same instance so that multiple calls can be chained.

public static Progress UseRenderHook(Progress progress, Func<IRenderable, IReadOnlyList<ProgressTask>, IRenderable> renderHook)

Sets an optional hook to intercept rendering.

Parameters:

progress (Progress)
The Progress instance.
renderHook (Func<IRenderable, IReadOnlyList<ProgressTask>, IRenderable>)
The custom render function.

Returns:

The same instance so that multiple calls can be chained.