Class Keybindings

Keybindings renderable

Inheritance
object
CyclicWriter
SimpleCyclicWriter
Keybindings
Namespace: Terminaux.Writer.CyclicWriters.Simple
Assembly: Terminaux.dll
Syntax
public class Keybindings : SimpleCyclicWriter

Constructors

| Edit this page View Source

Keybindings()

Makes a new instance of the keybindings renderer

Declaration
public Keybindings()

Properties

| Edit this page View Source

BackgroundColor

Background color

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

BuiltinBackgroundColor

Built-in option key background color

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

BuiltinColor

Built-in option key color

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

BuiltinForegroundColor

Built-in option key name color

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

BuiltinKeybindings

Built-in key bindings

Declaration
public Keybinding[] BuiltinKeybindings { get; set; }
Property Value
Type Description
Keybinding[]
| Edit this page View Source

HelpKeyInfo

Help key info

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

KeybindingList

Key bindings

Declaration
public Keybinding[] KeybindingList { get; set; }
Property Value
Type Description
Keybinding[]
| Edit this page View Source

OptionBackgroundColor

Keybinding option key background color

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

OptionColor

Keybinding option key color

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

OptionForegroundColor

Keybinding option key name color

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

UseColors

Whether to use colors or not

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

Width

Width of the keybinding bar

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

WriteHelpKeyInfo

Whether to write help key info at the end of the keybinding bar upon overflow

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

WriteLabels

Whether to write labels or not

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

Methods

| Edit this page View Source

Render()

Renders the keybindings

Declaration
public override string Render()
Returns
Type Description
string

Rendered text that will be used by the renderer
Overrides