Class TerminalSystemConsole

Namespace

OneImlx.Terminal.Runtime

Assembly

OneImlx.Terminal.dll

The default implementation of ITerminalConsole that uses the system Console.

public class TerminalSystemConsole : ITerminalConsole

Inheritance

object

TerminalSystemConsole

Implements

ITerminalConsole

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

The TerminalSystemConsole is thread safe and allows multiple tasks to write to the console concurrently.

Constructors

TerminalSystemConsole()

Initializes a new instance of the TerminalSystemConsole class.

public TerminalSystemConsole()

Properties

BackgroundColor

Gets or sets the background color of the console.

public ConsoleColor BackgroundColor { get; set; }

Property Value

ConsoleColor

ForegroundColor

Gets or sets the foreground color of the console.

public ConsoleColor ForegroundColor { get; set; }

Property Value

ConsoleColor

Methods

ClearAsync()

Clears the console buffer and display information asynchronously.

public Task ClearAsync()

Returns

Task

Ignore(string?)

Determines whether the specified string value should be ignored by the ITerminalConsole.

public bool Ignore(string? value)

Parameters

value string

The value to check.

Returns

bool

true if the value is null, empty, or whitespace; otherwise, false.

ReadAnswerAsync(string, params string[]?)

Prints a question to the console and waits for an answer asynchronously.

public Task<string> ReadAnswerAsync(string question, params string[]? answers)

Parameters

question string

The question to print. A ? will be appended at the end.

answers string[]

The allowed answers, or null if all answers are allowed. If specified, this method prints the answers in the format {question} ({answer1}/{answer2}/{answer3})?.

Returns

Task<string>

The user's answer, or null if canceled.

ReadLineAsync()

Reads the next line of input from the console asynchronously.

public Task<string?> ReadLineAsync()

Returns

Task<string>

The next line of input, or null if no more lines are available.

WriteAsync(string, params object[])

Writes a formatted string to the console asynchronously.

public Task WriteAsync(string value, params object[] args)

Parameters

value string

The string to write.

args object[]

The format arguments.

Returns

Task

WriteColorAsync(ConsoleColor, string, params object[])

Writes a formatted string to the console in the specified foreground color asynchronously.

public Task WriteColorAsync(ConsoleColor foregroundColor, string value, params object[] args)

Parameters

foregroundColor ConsoleColor

The foreground color.

value string

The string to write.

args object[]

The format arguments.

Returns

Task

WriteLineAsync()

Writes a newline to the console asynchronously.

public Task WriteLineAsync()

Returns

Task

WriteLineAsync(string, params object[])

Writes a formatted string followed by a newline to the console asynchronously.

public Task WriteLineAsync(string value, params object[] args)

Parameters

value string

The string to write.

args object[]

The format arguments.

Returns

Task

WriteLineColorAsync(ConsoleColor, string, params object[])

Writes a formatted string followed by a newline in the specified foreground color to the console asynchronously.

public Task WriteLineColorAsync(ConsoleColor foregroundColor, string value, params object[] args)

Parameters

foregroundColor ConsoleColor

The foreground color.

value string

The string to write.

args object[]

The format arguments.

Returns

Task