Skip to content

TerminalAnsiOptions

Namespace: Hex1b.Automation

Assembly: Hex1b.dll

Options for ANSI rendering of terminal regions.

csharp
public class TerminalAnsiOptions

Inheritance

ObjectTerminalAnsiOptions

Properties

IncludeClearScreen

Whether to include escape sequences to clear the screen and reset cursor. Default is false to just render the content.

Returns: Boolean

csharp
public bool IncludeClearScreen { get; set; }

IncludeCursorPosition

Whether to include cursor positioning at the end (for snapshots). Default is true.

Returns: Boolean

csharp
public bool IncludeCursorPosition { get; set; }

IncludeTrailingNewline

Whether to include a trailing newline at the end of output. Useful when the output will be written to a file. Default is true.

Returns: Boolean

csharp
public bool IncludeTrailingNewline { get; set; }

RenderNullAsSpace

Whether to render null characters as spaces. Default is false to skip them entirely.

Returns: Boolean

csharp
public bool RenderNullAsSpace { get; set; }

ResetAtEnd

Whether to reset all attributes at the end of the output. Default is true to ensure terminal returns to normal state.

Returns: Boolean

csharp
public bool ResetAtEnd { get; set; }

Fields

Default

Default options for ANSI rendering.

Returns: TerminalAnsiOptions

csharp
public static readonly TerminalAnsiOptions Default

Released under the MIT License.