Class TermReaderState

State of the reader

Inheritance

object

TermReaderState

Namespace

Terminaux.Reader @ Terminaux.dll

Syntax

public class TermReaderState

Properties

ArgumentNumber

Argument number to utilize

Property Value

int

Declaration

public int ArgumentNumber { get; }

CanInsert

Can insert a new character?

Property Value

bool

Declaration

public bool CanInsert { get; }

Commentized

Whether the current input character is commentized by the hashtag (#) character or not.

Property Value

bool

Declaration

public bool Commentized { get; }

Concealing

Whether the input is concealed right now

Property Value

bool

Declaration

public bool Concealing { get; }

CurrentCursorPosLeft

Current cursor left position

Property Value

int

Declaration

public int CurrentCursorPosLeft { get; }

CurrentCursorPosTop

Current cursor top position

Property Value

int

Declaration

public int CurrentCursorPosTop { get; }

CurrentHistoryPos

Current history number

Property Value

int

Declaration

public int CurrentHistoryPos { get; }

CurrentState

Gets the current state

Property Value

TermReaderState

Declaration

public static TermReaderState? CurrentState { get; }

CurrentSuggestionsPos

Current suggestion number

Property Value

int

Declaration

public int CurrentSuggestionsPos { get; }

CurrentSuggestionsTextPos

Current suggestions text position

Property Value

int

Declaration

public int CurrentSuggestionsTextPos { get; }

CurrentText

Current text

Property Value

StringBuilder

Declaration

public StringBuilder CurrentText { get; }

CurrentTextPos

Current text character number

Property Value

int

Declaration

public int CurrentTextPos { get; }

History

History entries

Property Value

string[]

Declaration

public string[] History { get; }

InputPromptHeight

Input prompt text

Property Value

int

Declaration

public int InputPromptHeight { get; }

InputPromptLastLine

Input prompt last line

Property Value

string

Declaration

public string InputPromptLastLine { get; }

InputPromptLastLineLength

Input prompt last line length

Property Value

int

Declaration

public int InputPromptLastLineLength { get; }

InputPromptLeft

Left position of the input prompt (with the left margin)

Property Value

int

Declaration

public int InputPromptLeft { get; }

InputPromptLeftBegin

Left position of the input prompt (where the first letter of the input prompt is located)

Property Value

int

Declaration

public int InputPromptLeftBegin { get; }

InputPromptText

Input prompt text

Property Value

string

Declaration

public string InputPromptText { get; }

InputPromptTop

Top position of the input prompt

Property Value

int

Declaration

public int InputPromptTop { get; }

InputPromptTopBegin

Top position of the input prompt (where the first letter of the input prompt is located)

Property Value

int

Declaration

public int InputPromptTopBegin { get; }

KillBuffer

Text to be pasted

Property Value

StringBuilder

Declaration

public StringBuilder KillBuffer { get; }

LeftMargin

Left margin

Property Value

int

Declaration

public int LeftMargin { get; }

LongestSentenceLengthFromLeft

Longest sentence length (from the leftmost position, without offset created by the last line in the prompt)

Property Value

int

Declaration

public int LongestSentenceLengthFromLeft { get; }

LongestSentenceLengthFromLeftForFirstLine

Longest sentence length (from the leftmost position, with the length of the last line in the prompt plus the left margin)

Property Value

int

Declaration

public int LongestSentenceLengthFromLeftForFirstLine { get; }

LongestSentenceLengthFromLeftForGeneralLine

Longest sentence length (from the leftmost position, with the left margin)

Property Value

int

Declaration

public int LongestSentenceLengthFromLeftForGeneralLine { get; }

MaximumInputPositionLeft

Maximum input left position

Property Value

int

Declaration

public int MaximumInputPositionLeft { get; }

OneLineWrap

Whether one line wrapping is enabled

Property Value

bool

Declaration

public bool OneLineWrap { get; }

OperationWasInvalid

Whether an invalid key was pressed, or an invalid operation was performed, or not.

Property Value

bool

Declaration

public bool OperationWasInvalid { get; }

PasswordMode

Password Mode

Property Value

bool

Declaration

public bool PasswordMode { get; }

PressedKey

Currently pressed key

Property Value

ConsoleKeyInfo

Declaration

public ConsoleKeyInfo PressedKey { get; }

RefreshRequired

Whether the refresh is required

Property Value

bool

Declaration

public bool RefreshRequired { get; set; }

RightMargin

Right margin

Property Value

int

Declaration

public int RightMargin { get; }

Settings

Reader settings (general or overridden)

Property Value

TermReaderSettings

Declaration

public TermReaderSettings Settings { get; }

Width

Width of the reader

Property Value

int

Declaration

public int Width { get; }