Class TerminalSystemConsole

Namespace

OneImlx.Terminal.Runtime

Assembly

OneImlx.Terminal.dll

The default ITerminalConsole implementation that use 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()

Properties

BackgroundColor

The background color.

public ConsoleColor BackgroundColor { get; set; }

Property Value

ConsoleColor

ForegroundColor

The foreground color.

public ConsoleColor ForegroundColor { get; set; }

Property Value

ConsoleColor

In

Gets the standard input stream.

public TextReader In { get; }

Property Value

TextReader

Out

Gets the standard output stream.

public TextWriter Out { get; }

Property Value

TextWriter

Methods

ClearAsync()

Clears the Console buffer and the corresponding display information.

public Task ClearAsync()

Returns

Task

Ignore(string?)

Return true if the specified string value is ignored by the ITerminalConsole, otherwise false.

public bool Ignore(string? value)

Parameters

value string

The value to check.

Returns

bool

ReadAnswerAsync(string, params string[]?)

Prints the question to the ITerminalConsole standard output stream and waits for an answer asynchronously.

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

Parameters

question string

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

answers string[]

The allowed answers or null if all answers are allowed. It is recommended to keep the answers short for readability. If specified this method will print the answers with question in the format {question} {answer1}/{answer2}/{answer3}?

Returns

Task<string>

The answer for the question or null if canceled.

ReadLineAsync()

Reads the next line of characters from the Console input stream asynchronously.

public Task<string?> ReadLineAsync()

Returns

Task<string>

The next line of characters from the input stream, or null if no more lines are available.

WriteAsync(string, params object[])

Writes the specified string value to the Console standard output stream.

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

Parameters

value string

The value to write.

args object[]

The format arguments.

Returns

Task

WriteColorAsync(ConsoleColor, string, params object[])

Writes the specified string value in the foreground color to the Console standard output stream.

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

Parameters

foregroundColor ConsoleColor

The foreground text color.

value string

The text to write.

args object[]

The format arguments.

Returns

Task

WriteLineAsync()

Writes the current newline terminator to the Console input stream asynchronously.

public Task WriteLineAsync()

Returns

Task

WriteLineAsync(string, params object[])

Writes the specified string value followed by the current newline terminator to the Console input stream asynchronously.

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

Parameters

value string

The text to write.

args object[]

The format arguments.

Returns

Task

WriteLineColorAsync(ConsoleColor, string, params object[])

Writes the specified string value followed by the current newline terminator to the Console input stream asynchronously.

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

Parameters

foregroundColor ConsoleColor

The foreground text color.

value string

The text to write.

args object[]

The format arguments.

Returns

Task