Class TermReaderState
State of the reader
Inheritance
Namespace: Terminaux.Reader
Assembly: Terminaux.dll
Syntax
public class TermReaderState
Properties
| Edit this page View SourceArgumentNumber
Argument number to utilize
Declaration
public int ArgumentNumber { get; }
Property Value
Type | Description |
---|---|
int |
CanInsert
Can insert a new character?
Declaration
public bool CanInsert { get; }
Property Value
Type | Description |
---|---|
bool |
Commentized
Whether the current input character is commentized by the hashtag (#
) character or not.
Declaration
public bool Commentized { get; }
Property Value
Type | Description |
---|---|
bool |
Concealing
Whether the input is concealed right now
Declaration
public bool Concealing { get; }
Property Value
Type | Description |
---|---|
bool |
CurrentCursorPosLeft
Current cursor left position
Declaration
public int CurrentCursorPosLeft { get; }
Property Value
Type | Description |
---|---|
int |
CurrentCursorPosTop
Current cursor top position
Declaration
public int CurrentCursorPosTop { get; }
Property Value
Type | Description |
---|---|
int |
CurrentHistoryPos
Current history number
Declaration
public int CurrentHistoryPos { get; }
Property Value
Type | Description |
---|---|
int |
CurrentState
Gets the current state
Declaration
public static TermReaderState? CurrentState { get; }
Property Value
Type | Description |
---|---|
TermReaderState |
CurrentSuggestionsPos
Current suggestion number
Declaration
public int CurrentSuggestionsPos { get; }
Property Value
Type | Description |
---|---|
int |
CurrentSuggestionsTextPos
Current suggestions text position
Declaration
public int CurrentSuggestionsTextPos { get; }
Property Value
Type | Description |
---|---|
int |
CurrentText
Current text
Declaration
public StringBuilder CurrentText { get; }
Property Value
Type | Description |
---|---|
StringBuilder |
CurrentTextPos
Current text character number
Declaration
public int CurrentTextPos { get; }
Property Value
Type | Description |
---|---|
int |
History
History entries
Declaration
public string[] History { get; }
Property Value
Type | Description |
---|---|
string[] |
InputPromptHeight
Input prompt text
Declaration
public int InputPromptHeight { get; }
Property Value
Type | Description |
---|---|
int |
InputPromptLastLine
Input prompt last line
Declaration
public string InputPromptLastLine { get; }
Property Value
Type | Description |
---|---|
string |
InputPromptLastLineLength
Input prompt last line length
Declaration
public int InputPromptLastLineLength { get; }
Property Value
Type | Description |
---|---|
int |
InputPromptLeft
Left position of the input prompt (with the left margin)
Declaration
public int InputPromptLeft { get; }
Property Value
Type | Description |
---|---|
int |
InputPromptLeftBegin
Left position of the input prompt (where the first letter of the input prompt is located)
Declaration
public int InputPromptLeftBegin { get; }
Property Value
Type | Description |
---|---|
int |
InputPromptText
Input prompt text
Declaration
public string InputPromptText { get; }
Property Value
Type | Description |
---|---|
string |
InputPromptTop
Top position of the input prompt
Declaration
public int InputPromptTop { get; }
Property Value
Type | Description |
---|---|
int |
InputPromptTopBegin
Top position of the input prompt (where the first letter of the input prompt is located)
Declaration
public int InputPromptTopBegin { get; }
Property Value
Type | Description |
---|---|
int |
KillBuffer
Text to be pasted
Declaration
public StringBuilder KillBuffer { get; }
Property Value
Type | Description |
---|---|
StringBuilder |
LeftMargin
Left margin
Declaration
public int LeftMargin { get; }
Property Value
Type | Description |
---|---|
int |
LongestSentenceLengthFromLeft
Longest sentence length (from the leftmost position, without offset created by the last line in the prompt)
Declaration
public int LongestSentenceLengthFromLeft { get; }
Property Value
Type | Description |
---|---|
int |
LongestSentenceLengthFromLeftForFirstLine
Longest sentence length (from the leftmost position, with the length of the last line in the prompt plus the left margin)
Declaration
public int LongestSentenceLengthFromLeftForFirstLine { get; }
Property Value
Type | Description |
---|---|
int |
LongestSentenceLengthFromLeftForGeneralLine
Longest sentence length (from the leftmost position, with the left margin)
Declaration
public int LongestSentenceLengthFromLeftForGeneralLine { get; }
Property Value
Type | Description |
---|---|
int |
MaximumInputPositionLeft
Maximum input left position
Declaration
public int MaximumInputPositionLeft { get; }
Property Value
Type | Description |
---|---|
int |
OneLineWrap
Whether one line wrapping is enabled
Declaration
public bool OneLineWrap { get; }
Property Value
Type | Description |
---|---|
bool |
OperationWasInvalid
Whether an invalid key was pressed, or an invalid operation was performed, or not.
Declaration
public bool OperationWasInvalid { get; }
Property Value
Type | Description |
---|---|
bool |
PasswordMode
Password Mode
Declaration
public bool PasswordMode { get; }
Property Value
Type | Description |
---|---|
bool |
PressedKey
Currently pressed key
Declaration
public ConsoleKeyInfo PressedKey { get; }
Property Value
Type | Description |
---|---|
ConsoleKeyInfo |
RefreshRequired
Whether the refresh is required
Declaration
public bool RefreshRequired { get; set; }
Property Value
Type | Description |
---|---|
bool |
RightMargin
Right margin
Declaration
public int RightMargin { get; }
Property Value
Type | Description |
---|---|
int |
Settings
Reader settings (general or overridden)
Declaration
public TermReaderSettings Settings { get; }
Property Value
Type | Description |
---|---|
TermReaderSettings |