Skip to content
ConsoleMonster

API Reference

Class

TerminalTargetExtensions

Edit on GitHub
Namespace ConsoleMonster.Output
Assembly ConsoleMonster
Source TerminalTargetExtensions.cs:19
Modifiers static

The Terminal methods for an explicit target, for libraries that take a target through a constructor or options instead of writing to the process console: target.Write(table), target.WriteMarkupLine(...), target.Status(...). Each call runs inside Terminal.Use for that target, so nested writes, prompts and live sessions go to the same place, and nothing global changes.

Inheritance

  • Object
  • TerminalTargetExtensions

Methods

public static RenderContext CreateContext(ITerminalTarget target) #
TerminalTargetExtensions.cs:87
Returns: RenderContext

A render context for the target's profile and theme (for measuring or rendering by hand).

Parameters

target ConsoleMonster.Output.ITerminalTarget requiredposition: 0
The target.

Returns

The context.

public static Void Status(ITerminalTarget target, String markup, Action<StatusContext> action) #
TerminalTargetExtensions.cs:67
Returns: Void

Runs work under a status (see Terminal.Status).

Parameters

target ConsoleMonster.Output.ITerminalTarget requiredposition: 0
The target.
markup System.String requiredposition: 1
The first status text.
action System.Action<ConsoleMonster.Output.StatusContext> requiredposition: 2
The work.
public static async Task StatusAsync(ITerminalTarget target, String markup, Func<StatusContext, Task> action) #
Returns: Task

Runs asynchronous work under a status.

Parameters

target ConsoleMonster.Output.ITerminalTarget requiredposition: 0
The target.
markup System.String requiredposition: 1
The first status text.
action System.Func<ConsoleMonster.Output.StatusContext, System.Threading.Tasks.Task> requiredposition: 2
The work.

Returns

A task that completes when the work has finished.

public static Void Write(ITerminalTarget target, IWidget widget) #
TerminalTargetExtensions.cs:19
Returns: Void

Writes a widget once.

Parameters

target ConsoleMonster.Output.ITerminalTarget requiredposition: 0
The target.
widget ConsoleMonster.Layout.IWidget requiredposition: 1
The widget.
public static Void WriteLines(ITerminalTarget target, IReadOnlyList<StyledLine> lines, Boolean newLine = true) #
TerminalTargetExtensions.cs:57
Returns: Void

Writes styled lines; with newLine false the last line is left open.

Parameters

target ConsoleMonster.Output.ITerminalTarget requiredposition: 0
The target.
lines System.Collections.Generic.IReadOnlyList<ConsoleMonster.Text.StyledLine> requiredposition: 1
The lines.
newLine System.Boolean = true optionalposition: 2
Whether to end the last line.
public static Void WriteMarkup(ITerminalTarget target, String markup) #
TerminalTargetExtensions.cs:28
Returns: Void

Writes markup without ending the line.

Parameters

target ConsoleMonster.Output.ITerminalTarget requiredposition: 0
The target.
markup System.String requiredposition: 1
The markup.
public static Void WriteMarkupLine(ITerminalTarget target, String markup) #
TerminalTargetExtensions.cs:37
Returns: Void

Writes one line of markup.

Parameters

target ConsoleMonster.Output.ITerminalTarget requiredposition: 0
The target.
markup System.String requiredposition: 1
The markup.
public static Void WriteRich(ITerminalTarget target, RichText text, Boolean newLine = true) #
TerminalTargetExtensions.cs:47
Returns: Void

Writes rich text as lines; with newLine false the last line is left open.

Parameters

target ConsoleMonster.Output.ITerminalTarget requiredposition: 0
The target.
text ConsoleMonster.Text.RichText requiredposition: 1
The rich text.
newLine System.Boolean = true optionalposition: 2
Whether to end the last line.