AnsiConsole

Gets or sets the underlying IAnsiConsole.

Gets the IAnsiConsoleCursor.

Gets the console profile.

public static void AlternateScreen(Action action)

Switches to an alternate screen buffer if the terminal supports it.

public static T Ask<T>(string prompt)

Displays a prompt to the user.

public static T Ask<T>(string prompt, T defaultValue)

Displays a prompt to the user with a given default.

public static Task<T> AskAsync<T>(string prompt, CancellationToken cancellationToken = default)

Displays a prompt to the user.

public static Task<T> AskAsync<T>(string prompt, T defaultValue, CancellationToken cancellationToken = default)

Displays a prompt to the user with a given default.

public static void Clear()

Clears the console.

public static bool Confirm(string prompt, bool defaultValue = true)

Displays a prompt with two choices, yes or no.

public static Task<bool> ConfirmAsync(string prompt, bool defaultValue = true, CancellationToken cancellationToken = default)

Displays a prompt with two choices, yes or no.

public static IAnsiConsole Create(AnsiConsoleSettings settings)

Creates a new IAnsiConsole instance from the provided settings.

public static string ExportCustom(IAnsiConsoleEncoder encoder)

Exports all recorded console output using a custom encoder.

public static string ExportHtml()

Exports all recorded console output as HTML text.

public static string ExportText()

Exports all recorded console output as text.

public static LiveDisplay Live(IRenderable target)

Creates a new LiveDisplay instance.

public static void Markup(string value)

Writes the specified markup to the console.

public static void Markup(string format, object[] args)

Writes the specified markup to the console.

public static void Markup(IFormatProvider provider, string format, object[] args)

Writes the specified markup to the console.

public static void MarkupInterpolated(FormattableString value)

Writes the specified markup to the console. All interpolation holes which contain a string are automatically escaped.

public static void MarkupInterpolated(IFormatProvider provider, FormattableString value)

Writes the specified markup to the console. All interpolation holes which contain a string are automatically escaped.

public static void MarkupLine(string value)

Writes the specified markup, followed by the current line terminator, to the console.

public static void MarkupLine(string format, object[] args)

Writes the specified markup, followed by the current line terminator, to the console.

public static void MarkupLine(IFormatProvider provider, string format, object[] args)

Writes the specified markup, followed by the current line terminator, to the console.

public static void MarkupLineInterpolated(FormattableString value)

Writes the specified markup, followed by the current line terminator, to the console. All interpolation holes which contain a string are automatically escaped.

public static void MarkupLineInterpolated(IFormatProvider provider, FormattableString value)

Writes the specified markup, followed by the current line terminator, to the console. All interpolation holes which contain a string are automatically escaped.

public static Progress Progress()

Creates a new Progress instance.

public static T Prompt<T>(IPrompt<T> prompt)

Displays a prompt to the user.

public static Task<T> PromptAsync<T>(IPrompt<T> prompt, CancellationToken cancellationToken = default)

Displays a prompt to the user.

public static void Record()

Starts recording the console output.

public static void Reset()

Resets colors and text decorations.

public static void ResetColors()

Resets the current applied foreground and background colors.

public static void ResetDecoration()

Resets the current applied text decorations.

public static Status Status()

Creates a new Status instance.

public static void Write(IRenderable renderable)

Renders the specified IRenderable to the console.

public static void Write(string value)

Writes the specified string value to the console.

public static void Write(int value)

Writes the text representation of the specified 32-bit signed integer value to the console.

public static void Write(IFormatProvider provider, int value)

Writes the text representation of the specified 32-bit signed integer value to the console.

public static void Write(uint value)

Writes the text representation of the specified 32-bit unsigned integer value to the console.

public static void Write(IFormatProvider provider, uint value)

Writes the text representation of the specified 32-bit unsigned integer value to the console.

public static void Write(long value)

Writes the text representation of the specified 64-bit signed integer value to the console.

public static void Write(IFormatProvider provider, long value)

Writes the text representation of the specified 64-bit signed integer value to the console.

public static void Write(ulong value)

Writes the text representation of the specified 64-bit unsigned integer value to the console.

public static void Write(IFormatProvider provider, ulong value)

Writes the text representation of the specified 64-bit unsigned integer value to the console.

public static void Write(float value)

Writes the text representation of the specified single-precision floating-point value to the console.

public static void Write(IFormatProvider provider, float value)

Writes the text representation of the specified single-precision floating-point value to the console.

public static void Write(double value)

Writes the text representation of the specified double-precision floating-point value to the console.

public static void Write(IFormatProvider provider, double value)

Writes the text representation of the specified double-precision floating-point value to the console.

public static void Write(decimal value)

Writes the text representation of the specified decimal value, to the console.

public static void Write(IFormatProvider provider, decimal value)

Writes the text representation of the specified decimal value, to the console.

public static void Write(bool value)

Writes the text representation of the specified boolean value to the console.

public static void Write(IFormatProvider provider, bool value)

Writes the text representation of the specified boolean value to the console.

public static void Write(char value)

Writes the specified Unicode character to the console.

public static void Write(IFormatProvider provider, char value)

Writes the specified Unicode character to the console.

public static void Write(char[] value)

Writes the specified array of Unicode characters to the console.

public static void Write(IFormatProvider provider, char[] value)

Writes the specified array of Unicode characters to the console.

public static void Write(string format, object[] args)

Writes the text representation of the specified array of objects, to the console using the specified format information.

public static void Write(IFormatProvider provider, string format, object[] args)

Writes the text representation of the specified array of objects, to the console using the specified format information.

public static void WriteException(Exception exception, ExceptionFormats format = 0)

Writes an exception to the console.

public static void WriteException(Exception exception, ExceptionSettings settings)

Writes an exception to the console.

public static void WriteLine()

Writes an empty line to the console.

public static void WriteLine(string value)

Writes the specified string value, followed by the current line terminator, to the console.

public static void WriteLine(int value)

Writes the text representation of the specified 32-bit signed integer value, followed by the current line terminator, to the console.

public static void WriteLine(IFormatProvider provider, int value)

Writes the text representation of the specified 32-bit signed integer value, followed by the current line terminator, to the console.

public static void WriteLine(uint value)

Writes the text representation of the specified 32-bit unsigned integer value, followed by the current line terminator, to the console.

public static void WriteLine(IFormatProvider provider, uint value)

Writes the text representation of the specified 32-bit unsigned integer value, followed by the current line terminator, to the console.

public static void WriteLine(long value)

Writes the text representation of the specified 64-bit signed integer value, followed by the current line terminator, to the console.

public static void WriteLine(IFormatProvider provider, long value)

Writes the text representation of the specified 64-bit signed integer value, followed by the current line terminator, to the console.

public static void WriteLine(ulong value)

Writes the text representation of the specified 64-bit unsigned integer value, followed by the current line terminator, to the console.

public static void WriteLine(IFormatProvider provider, ulong value)

Writes the text representation of the specified 64-bit unsigned integer value, followed by the current line terminator, to the console.

public static void WriteLine(float value)

Writes the text representation of the specified single-precision floating-point value, followed by the current line terminator, to the console.

public static void WriteLine(IFormatProvider provider, float value)

Writes the text representation of the specified single-precision floating-point value, followed by the current line terminator, to the console.

public static void WriteLine(double value)

Writes the text representation of the specified double-precision floating-point value, followed by the current line terminator, to the console.

public static void WriteLine(IFormatProvider provider, double value)

Writes the text representation of the specified double-precision floating-point value, followed by the current line terminator, to the console.

public static void WriteLine(decimal value)

Writes the text representation of the specified decimal value, followed by the current line terminator, to the console.

public static void WriteLine(IFormatProvider provider, decimal value)

Writes the text representation of the specified decimal value, followed by the current line terminator, to the console.

public static void WriteLine(bool value)

Writes the text representation of the specified boolean value, followed by the current line terminator, to the console.

public static void WriteLine(IFormatProvider provider, bool value)

Writes the text representation of the specified boolean value, followed by the current line terminator, to the console.

public static void WriteLine(char value)

Writes the specified Unicode character, followed by the current line terminator, value to the console.

public static void WriteLine(IFormatProvider provider, char value)

Writes the specified Unicode character, followed by the current line terminator, value to the console.

public static void WriteLine(char[] value)

Writes the specified array of Unicode characters, followed by the current line terminator, value to the console.

public static void WriteLine(IFormatProvider provider, char[] value)

Writes the specified array of Unicode characters, followed by the current line terminator, value to the console.

public static void WriteLine(string format, object[] args)

Writes the text representation of the specified array of objects, followed by the current line terminator, to the console using the specified format information.

public static void WriteLine(IFormatProvider provider, string format, object[] args)

Writes the text representation of the specified array of objects, followed by the current line terminator, to the console using the specified format information.