C# Class System.ConsolePal.TerminalFormatStrings

Provides format strings and related information for use with the current terminal.
Show file Open project: dotnet/corefx

Public Properties

Property Type Description
Background string
Bell string
Clear string
Columns int
CursorAddress string
CursorInvisible string
CursorLeft string
CursorVisible string
Foreground string
KeyFormatToConsoleKey ConsoleKeyInfo>.Dictionary
KeypadXmit string
Lines int
MaxColors int
MaxKeyFormatLength int
MinKeyFormatLength int
Reset string
Title string

Public Methods

Method Description
TerminalFormatStrings ( TermInfo db ) : Microsoft.Win32.SafeHandles

Private Methods

Method Description
AddKey ( TermInfo db, TermInfo keyId, ConsoleKey key ) : void
AddKey ( TermInfo db, TermInfo keyId, ConsoleKey key, bool shift, bool alt, bool control ) : void
AddKey ( TermInfo db, string extendedName, ConsoleKey key, bool shift, bool alt, bool control ) : void
AddPrefixKey ( TermInfo db, string extendedNamePrefix, ConsoleKey key ) : void
GetTitle ( TermInfo db ) : string

Method Details

TerminalFormatStrings() public method

public TerminalFormatStrings ( TermInfo db ) : Microsoft.Win32.SafeHandles
db TermInfo
return Microsoft.Win32.SafeHandles

Property Details

Background public property

The format string to use to change the background color.
public string Background
return string

Bell public property

The format string to use for an audible bell.
public string Bell
return string

Clear public property

The format string to use to clear the terminal.
public string Clear
return string

Columns public property

The number of columns in a format.
public int Columns
return int

CursorAddress public property

The format string to use to set the position of the cursor.
public string CursorAddress
return string

CursorInvisible public property

The format string to use to make cursor invisible
public string CursorInvisible
return string

CursorLeft public property

The format string to use to move the cursor to the left.
public string CursorLeft
return string

CursorVisible public property

The format string to use to make cursor visible.
public string CursorVisible
return string

Foreground public property

The format string to use to change the foreground color.
public string Foreground
return string

KeyFormatToConsoleKey public property

The dictionary of keystring to ConsoleKeyInfo. Only some members of the ConsoleKeyInfo are used; in particular, the actual char is ignored.
public Dictionary KeyFormatToConsoleKey
return ConsoleKeyInfo>.Dictionary

KeypadXmit public property

The ANSI string used to enter "application" / "keypad transmit" mode.
public string KeypadXmit
return string

Lines public property

The number of lines in a format.
public int Lines
return int

MaxColors public property

The maximum number of colors supported by the terminal.
public int MaxColors
return int

MaxKeyFormatLength public property

Max key length
public int MaxKeyFormatLength
return int

MinKeyFormatLength public property

Min key length
public int MinKeyFormatLength
return int

Reset public property

The format string to use to reset the foreground and background colors.
public string Reset
return string

Title public property

The format string to use to set the window title.
public string Title
return string