Class TermReaderSettings

Settings for the reader

Inheritance
object
TermReaderSettings
Namespace: Terminaux.Reader
Assembly: Terminaux.dll
Syntax
public class TermReaderSettings

Constructors

| Edit this page View Source

TermReaderSettings()

Initializes an empty reader settings instance

Declaration
public TermReaderSettings()
| Edit this page View Source

TermReaderSettings(TermReaderSettings)

Initializes a reader settings instance

Declaration
public TermReaderSettings(TermReaderSettings settings)
Parameters
Type Name Description
TermReaderSettings settings

Settings to copy from

Properties

| Edit this page View Source

BassBoomLibraryPath

Root path to BassBoom's library path

Declaration
public string BassBoomLibraryPath { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Bell

Console bell type for invalid reader operation

Declaration
public ConsoleBell Bell { get; set; }
Property Value
Type Description
ConsoleBell
| Edit this page View Source

CueEnter

A stream for the submission key press keyboard cue

Declaration
public Stream CueEnter { get; set; }
Property Value
Type Description
Stream
| Edit this page View Source

CueRubout

A stream for the backspace key press keyboard cue

Declaration
public Stream CueRubout { get; set; }
Property Value
Type Description
Stream
| Edit this page View Source

CueVolume

Keyboard cue volume

Declaration
public double CueVolume { get; set; }
Property Value
Type Description
double
| Edit this page View Source

CueVolumeBoost

Whether to boost cue volume up to 3.0 or not

Declaration
public bool CueVolumeBoost { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

CueWrite

A stream for the key press keyboard cue

Declaration
public Stream CueWrite { get; set; }
Property Value
Type Description
Stream
| Edit this page View Source

DefaultValueFormat

Default value format when showing it is enabled

Declaration
public string DefaultValueFormat { get; set; }
Property Value
Type Description
string
| Edit this page View Source

HistoryEnabled

Input history enabled

Declaration
public bool HistoryEnabled { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

HistoryName

Input history name

Declaration
public string HistoryName { get; set; }
Property Value
Type Description
string
| Edit this page View Source

InitialPosition

Initial position of the reader. This is applied only when the default value is supplied and WriteDefaultValue is on.

Declaration
public int InitialPosition { get; set; }
Property Value
Type Description
int
| Edit this page View Source

InputBackgroundColor

Input background color

Declaration
public Color InputBackgroundColor { get; set; }
Property Value
Type Description
Color
| Edit this page View Source

InputForegroundColor

Input foreground color

Declaration
public Color InputForegroundColor { get; set; }
Property Value
Type Description
Color
| Edit this page View Source

InputPlaceholderForegroundColor

Input placeholder foreground color

Declaration
public Color InputPlaceholderForegroundColor { get; set; }
Property Value
Type Description
Color
| Edit this page View Source

InputPromptForegroundColor

Input prompt foreground color

Declaration
public Color InputPromptForegroundColor { get; set; }
Property Value
Type Description
Color
| Edit this page View Source

KeyboardCues

Play keyboard cues for each keypress

Declaration
public bool KeyboardCues { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

LeftMargin

Left margin

Declaration
public int LeftMargin { get; set; }
Property Value
Type Description
int
| Edit this page View Source

PasswordMaskChar

Password mask character

Declaration
public char PasswordMaskChar { get; set; }
Property Value
Type Description
char
| Edit this page View Source

PlaceholderText

Show placeholder hint text

Declaration
public string PlaceholderText { get; set; }
Property Value
Type Description
string
| Edit this page View Source

PlayEnterCue

Play keyboard cues for pressing Enter

Declaration
public bool PlayEnterCue { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

PlayRuboutCue

Play keyboard cues for pressing Backspace

Declaration
public bool PlayRuboutCue { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

PlayWriteCue

Play keyboard cues for character insertion and other actions

Declaration
public bool PlayWriteCue { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

PrintDefaultValue

Prints the default value. Conflicts with WriteDefaultValue

Declaration
public bool PrintDefaultValue { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

RightMargin

Right margin

Declaration
public int RightMargin { get; set; }
Property Value
Type Description
int
| Edit this page View Source

Suggestions

Suggestion entries

Declaration
public Func<string, int, char[], string[]> Suggestions { set; }
Property Value
Type Description
Func<string, int, char[], string[]>
| Edit this page View Source

SuggestionsDelimiters

Suggestion delimiters

Declaration
public char[] SuggestionsDelimiters { set; }
Property Value
Type Description
char[]
| Edit this page View Source

SyntaxHighlighter

Syntax highlighter to use. It must be registered.

Declaration
public SyntaxHighlighting? SyntaxHighlighter { get; set; }
Property Value
Type Description
SyntaxHighlighting
| Edit this page View Source

SyntaxHighlighterEnabled

Syntax highlighter is enabled

Declaration
public bool SyntaxHighlighterEnabled { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

TreatCtrlCAsInput

Treat Ctrl + C as input

Declaration
public bool TreatCtrlCAsInput { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

WriteDefaultValue

Writes the default value to the actual input. Conflicts with PrintDefaultValue

Declaration
public bool WriteDefaultValue { get; set; }
Property Value
Type Description
bool