Class TermReaderSettings

Settings for the reader

Inheritance

object

TermReaderSettings

Namespace

Syntax

public class TermReaderSettings

Constructors

TermReaderSettings()

Initializes an empty reader settings instance

Declaration

public TermReaderSettings()

TermReaderSettings(TermReaderSettings)

Initializes a reader settings instance

Declaration

public TermReaderSettings(TermReaderSettings settings)

Parameters

Name	Type	Description
settings	TermReaderSettings	Settings to copy from

Properties

AutoInitialPosition

Automatically changes the initial position. This is applied only when the default value is supplied and WriteDefaultValue is on.

Property Value

bool

Declaration

public bool AutoInitialPosition { get; set; }

Bell

Console bell type for invalid reader operation

Property Value

ConsoleBell

Declaration

public ConsoleBell Bell { get; set; }

CueEnter

A stream for the submission key press keyboard cue

Property Value

Stream

Declaration

public Stream CueEnter { get; set; }

CueRubout

A stream for the backspace key press keyboard cue

Property Value

Stream

Declaration

public Stream CueRubout { get; set; }

CueVolume

Keyboard cue volume

Property Value

double

Declaration

public double CueVolume { get; set; }

CueVolumeBoost

Whether to boost cue volume up to 3.0 or not

Property Value

bool

Declaration

public bool CueVolumeBoost { get; set; }

CueWrite

A stream for the key press keyboard cue

Property Value

Stream

Declaration

public Stream CueWrite { get; set; }

DefaultValueFormat

Default value format when showing it is enabled

Property Value

string

Declaration

public string DefaultValueFormat { get; set; }

DisableLock

Allow input to go through without waiting for the lock function to evaluate to true

Property Value

bool

Declaration

public bool DisableLock { get; set; }

HistoryEnabled

Input history enabled

Property Value

bool

Declaration

public bool HistoryEnabled { get; set; }

HistoryName

Input history name

Property Value

string

Declaration

public string HistoryName { get; set; }

InitialPosition

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

Property Value

int

Declaration

public int InitialPosition { get; set; }

InputBackgroundColor

Input background color

Property Value

Color

Declaration

public Color InputBackgroundColor { get; set; }

InputForegroundColor

Input foreground color

Property Value

Color

Declaration

public Color InputForegroundColor { get; set; }

InputPlaceholderForegroundColor

Input placeholder foreground color

Property Value

Color

Declaration

public Color InputPlaceholderForegroundColor { get; set; }

InputPromptForegroundColor

Input prompt foreground color

Property Value

Color

Declaration

public Color InputPromptForegroundColor { get; set; }

KeyboardCues

Play keyboard cues for each keypress

Property Value

bool

Declaration

public bool KeyboardCues { get; set; }

LeftMargin

Left margin

Property Value

int

Declaration

public int LeftMargin { get; set; }

LockCondition

Function that evaluates the final boolean. True means to stop waiting and to allow input to go through.

Property Value

Func<bool>

Declaration

public Func<bool> LockCondition { get; set; }

PasswordMaskChar

Password mask character

Property Value

char

Declaration

public char PasswordMaskChar { get; set; }

PlaceholderText

Show placeholder hint text

Property Value

string

Declaration

public string PlaceholderText { get; set; }

PlayEnterCue

Play keyboard cues for pressing Enter

Property Value

bool

Declaration

public bool PlayEnterCue { get; set; }

PlayRuboutCue

Play keyboard cues for pressing Backspace

Property Value

bool

Declaration

public bool PlayRuboutCue { get; set; }

PlayWriteCue

Play keyboard cues for character insertion and other actions

Property Value

bool

Declaration

public bool PlayWriteCue { get; set; }

PrintDefaultValue

Prints the default value. Conflicts with WriteDefaultValue

Property Value

bool

Declaration

public bool PrintDefaultValue { get; set; }

RightMargin

Right margin

Property Value

int

Declaration

public int RightMargin { get; set; }

Suggestions

Suggestion entries

Property Value

Func<string, int, char[], string[]>

Declaration

public Func<string, int, char[], string[]> Suggestions { set; }

SuggestionsDelimiters

Suggestion delimiters

Property Value

char[]

Declaration

public char[] SuggestionsDelimiters { set; }

SyntaxHighlighter

Syntax highlighter to use. It must be registered.

Property Value

SyntaxHighlighting

Declaration

public SyntaxHighlighting? SyntaxHighlighter { get; set; }

SyntaxHighlighterEnabled

Syntax highlighter is enabled

Property Value

bool

Declaration

public bool SyntaxHighlighterEnabled { get; set; }

TreatCtrlCAsInput

Treat Ctrl + C as input

Property Value

bool

Declaration

public bool TreatCtrlCAsInput { get; set; }

UseDefaultValueOnEmpty

When input is empty, use default value

Property Value

bool

Declaration

public bool UseDefaultValueOnEmpty { get; set; }

Width

Width of the reader

Property Value

int

Declaration

public int Width { get; set; }

WriteDefaultValue

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

Property Value

bool

Declaration

public bool WriteDefaultValue { get; set; }