Class ConsoleWrapperTools

Wrapper for the System.Console class to ensure safety against dumb consoles and Windows-only features.

Inheritance

object

ConsoleWrapperTools

Namespace: Terminaux.Base

Assembly: Terminaux.dll

Syntax

public static class ConsoleWrapperTools

Properties

ActionBeep

Beeps the console

Declaration

public static Action ActionBeep { set; }

Property Value

Type	Description
Action

ActionBeepCustom

Beeps the console (with frequency and time)

Declaration

public static Action<int, int> ActionBeepCustom { set; }

Property Value

Type	Description
Action<int, int>

ActionBeepSeq

Beeps the console (VT Sequence method)

Declaration

public static Action ActionBeepSeq { set; }

Property Value

Type	Description
Action

ActionBufferHeight

The console buffer height (rows)

Declaration

public static Func<int> ActionBufferHeight { set; }

Property Value

Type	Description
Func<int>

ActionBufferWidth

The console buffer width (columns)

Declaration

public static Func<int> ActionBufferWidth { set; }

Property Value

Type	Description
Func<int>

ActionClear

Clears the console

Declaration

public static Action ActionClear { set; }

Property Value

Type	Description
Action

ActionClearLoadBack

Clears the console while loading the background

Declaration

public static Action ActionClearLoadBack { set; }

Property Value

Type	Description
Action

ActionCursorLeft

The cursor left position

Declaration

public static Func<int> ActionCursorLeft { set; }

Property Value

Type	Description
Func<int>

ActionCursorTop

The cursor top position

Declaration

public static Func<int> ActionCursorTop { set; }

Property Value

Type	Description
Func<int>

ActionCursorVisible

The cursor visibility mode

Declaration

public static Action<bool> ActionCursorVisible { set; }

Property Value

Type	Description
Action<bool>

ActionGetCursorPosition

Get cursor position

Declaration

public static Func<Coordinate> ActionGetCursorPosition { set; }

Property Value

Type	Description
Func<Coordinate>

ActionGetCursorVisible

The cursor visibility mode

Declaration

public static Func<bool> ActionGetCursorVisible { set; }

Property Value

Type	Description
Func<bool>

ActionGetTreatCtrlCAsInput

Whether to treat CTRL + C as input

Declaration

public static Func<bool> ActionGetTreatCtrlCAsInput { set; }

Property Value

Type	Description
Func<bool>

ActionIsDumb

Is the console a dumb console?

Declaration

public static Func<bool> ActionIsDumb { set; }

Property Value

Type	Description
Func<bool>

ActionKeyAvailable

Whether a key is pressed

Declaration

public static Func<bool> ActionKeyAvailable { set; }

Property Value

Type	Description
Func<bool>

ActionReadKey

Reads a key

• Boolean value indicates whether to intercept

Declaration

public static Func<bool, ConsoleKeyInfo> ActionReadKey { set; }

Property Value

Type	Description
Func<bool, ConsoleKeyInfo>

ActionSetBufferDimensions

Sets the buffer dimensions

• First integer is the buffer width from 0
  
• Second integer is the buffer height from 0

Declaration

public static Action<int, int> ActionSetBufferDimensions { set; }

Property Value

Type	Description
Action<int, int>

ActionSetBufferHeight

The console buffer height (rows, set)

Declaration

public static Action<int> ActionSetBufferHeight { set; }

Property Value

Type	Description
Action<int>

ActionSetBufferWidth

The console buffer width (columns, set)

Declaration

public static Action<int> ActionSetBufferWidth { set; }

Property Value

Type	Description
Action<int>

ActionSetCursorLeft

Sets the cursor left position

• First integer is the X position from 0

Declaration

public static Action<int> ActionSetCursorLeft { set; }

Property Value

Type	Description
Action<int>

ActionSetCursorPosition

Sets the cursor position

• First integer is the X position from 0
  
• Second integer is the Y position from 0

Declaration

public static Action<int, int> ActionSetCursorPosition { set; }

Property Value

Type	Description
Action<int, int>

ActionSetCursorTop

Sets the cursor top position

• First integer is the Y position from 0

Declaration

public static Action<int> ActionSetCursorTop { set; }

Property Value

Type	Description
Action<int>

ActionSetWindowDimensions

Sets the window dimensions

• First integer is the window width from 0
  
• Second integer is the window height from 0

Declaration

public static Action<int, int> ActionSetWindowDimensions { set; }

Property Value

Type	Description
Action<int, int>

ActionSetWindowHeight

The console window height (rows, set)

Declaration

public static Action<int> ActionSetWindowHeight { set; }

Property Value

Type	Description
Action<int>

ActionSetWindowWidth

The console window width (columns, set)

Declaration

public static Action<int> ActionSetWindowWidth { set; }

Property Value

Type	Description
Action<int>

ActionTreatCtrlCAsInput

Whether to treat CTRL + C as input

Declaration

public static Action<bool> ActionTreatCtrlCAsInput { set; }

Property Value

Type	Description
Action<bool>

ActionWindowHeight

The console window height (rows)

Declaration

public static Func<int> ActionWindowHeight { set; }

Property Value

Type	Description
Func<int>

ActionWindowWidth

The console window width (columns)

Declaration

public static Func<int> ActionWindowWidth { set; }

Property Value

Type	Description
Func<int>

ActionWriteChar

Writes a character to console

• A character

Declaration

public static Action<char> ActionWriteChar { set; }

Property Value

Type	Description
Action<char>

ActionWriteErrorChar

Writes a character to console

• A character

Declaration

public static Action<char> ActionWriteErrorChar { set; }

Property Value

Type	Description
Action<char>

ActionWriteErrorLine

Writes new line to console

Declaration

public static Action ActionWriteErrorLine { set; }

Property Value

Type	Description
Action

ActionWriteErrorLineParameterized

Writes text to console with line terminator

• The text to write
  
• The arguments to evaluate

Declaration

public static Action<string, object[]> ActionWriteErrorLineParameterized { set; }

Property Value

Type	Description
Action<string, object[]>

ActionWriteErrorLineString

Writes text to console with line terminator

• The text to write

Declaration

public static Action<string> ActionWriteErrorLineString { set; }

Property Value

Type	Description
Action<string>

ActionWriteErrorParameterized

Writes text to console

• The text to write
  
• The arguments to evaluate

Declaration

public static Action<string, object[]> ActionWriteErrorParameterized { set; }

Property Value

Type	Description
Action<string, object[]>

ActionWriteErrorString

Writes text to console

• The text to write

Declaration

public static Action<string> ActionWriteErrorString { set; }

Property Value

Type	Description
Action<string>

ActionWriteLine

Writes new line to console

Declaration

public static Action ActionWriteLine { set; }

Property Value

Type	Description
Action

ActionWriteLineParameterized

Writes text to console with line terminator

• The text to write
  
• The arguments to evaluate

Declaration

public static Action<string, object[]> ActionWriteLineParameterized { set; }

Property Value

Type	Description
Action<string, object[]>

ActionWriteLineString

Writes text to console with line terminator

• The text to write

Declaration

public static Action<string> ActionWriteLineString { set; }

Property Value

Type	Description
Action<string>

ActionWriteParameterized

Writes text to console

• The text to write
  
• The arguments to evaluate

Declaration

public static Action<string, object[]> ActionWriteParameterized { set; }

Property Value

Type	Description
Action<string, object[]>

ActionWriteString

Writes text to console

• The text to write

Declaration

public static Action<string> ActionWriteString { set; }

Property Value

Type	Description
Action<string>