Class TermReaderTools

Terminal reader tools

Inheritance

object

TermReaderTools

Namespace

Terminaux.Reader @ Terminaux.dll

Syntax

public static class TermReaderTools

Properties

Busy

Specifies whether the terminal reader is busy waiting for input or not (more general)

Property Value

bool

Declaration

public static bool Busy { get; }

Methods

GetMaximumInputLength()

Gets the maximum input length for the current reader session

Returns

int

The maximum input length of an input. -1 if there is no reader.

Declaration

public static int GetMaximumInputLength()

InsertNewText(string, bool, bool)

Inserts new text to the current reader

Declaration

public static void InsertNewText(string newText, bool append = false, bool step = true)

Parameters

Name	Type	Description
newText	string	New text to insert or append
append	bool	Whether to append the new text to the end of the input or to insert text to the current position
step	bool	Whether to move the cursor forward after inserting or not

Interrupt()

Interrupts the reading process

Declaration

public static void Interrupt()

Refresh()

Refreshes the reader prompt

Declaration

public static void Refresh()

RemoveText(int, bool)

Removes text from the current position

Declaration

public static void RemoveText(int length, bool step = false)

Parameters

Name	Type	Description
length	int	Length of characters to remove
step	bool	Whether to step backwards after removing characters

RemoveText(int, int, bool)

Removes text from the current position

Declaration

public static void RemoveText(int startIndex, int length, bool step = false)

Parameters

Name	Type	Description
startIndex	int	Zero-based index of where to start removing length characters
length	int	Length of characters to remove
step	bool	Whether to step backwards after removing characters

WaitForInput()

Waits indefinitely for an input. Returns immediately if not busy.

Declaration

public static void WaitForInput()

WipeAll()

Wipes the entire input

Declaration

public static void WipeAll()