Class KeybindingsWriter

Keybindings writer class

Inheritance
object
KeybindingsWriter
Namespace: Terminaux.Writer.MiscWriters
Assembly: Terminaux.dll
Syntax
[Obsolete("This is considered a legacy method of writing this fancy text and will be removed in a future version of Terminaux. Please use its cyclic writer equivalent.")]
public static class KeybindingsWriter

Methods

| Edit this page View Source

RenderKeybindings(Keybinding[], int, int, int, ConsoleKeyInfo?)

Renders the keybindings

Declaration
public static string RenderKeybindings(Keybinding[] bindings, int left = 0, int top = 0, int rightMargin = 0, ConsoleKeyInfo? helpKeyInfo = null)
Parameters
Type Name Description
Keybinding[] bindings

List of keybindings (without the builtin ones)
int left

Left position of the keybinding group
int top

Top position of the keybinding group
int rightMargin

Right margin of the keybinding group
ConsoleKeyInfo? helpKeyInfo

Key information that opens the help page
Returns
Type Description
string

Keybindings sequence that you can use with WriteRaw(string, params object[])
| Edit this page View Source

RenderKeybindings(Keybinding[], Color, int, int, int, ConsoleKeyInfo?)

Renders the keybindings

Declaration
public static string RenderKeybindings(Keybinding[] bindings, Color backgroundColor, int left = 0, int top = 0, int rightMargin = 0, ConsoleKeyInfo? helpKeyInfo = null)
Parameters
Type Name Description
Keybinding[] bindings

List of keybindings (without the builtin ones)
Color backgroundColor

Background color
int left

Left position of the keybinding group
int top

Top position of the keybinding group
int rightMargin

Right margin of the keybinding group
ConsoleKeyInfo? helpKeyInfo

Key information that opens the help page
Returns
Type Description
string

Keybindings sequence that you can use with WriteRaw(string, params object[])
| Edit this page View Source

RenderKeybindings(Keybinding[], Color, Color, Color, Color, Color, Color, int, int, int, ConsoleKeyInfo?)

Renders the keybindings

Declaration
public static string RenderKeybindings(Keybinding[] bindings, Color builtinColor, Color builtinForegroundColor, Color builtinBackgroundColor, Color optionColor, Color optionForegroundColor, Color optionBackgroundColor, int left = 0, int top = 0, int rightMargin = 0, ConsoleKeyInfo? helpKeyInfo = null)
Parameters
Type Name Description
Keybinding[] bindings

List of keybindings (without the builtin ones)
Color builtinColor

Built-in keybinding foreground color in the background color
Color builtinForegroundColor

Built-in keybinding foreground color out of the background color
Color builtinBackgroundColor

Built-in keybinding background color
Color optionColor

Option keybinding foreground color in the background color
Color optionForegroundColor

Option keybinding foreground color out of the background color
Color optionBackgroundColor

Option keybinding background color
int left

Left position of the keybinding group
int top

Top position of the keybinding group
int rightMargin

Right margin of the keybinding group
ConsoleKeyInfo? helpKeyInfo

Key information that opens the help page
Returns
Type Description
string

Keybindings sequence that you can use with WriteRaw(string, params object[])
| Edit this page View Source

RenderKeybindings(Keybinding[], Color, Color, Color, Color, Color, Color, Color, int, int, int, ConsoleKeyInfo?)

Renders the keybindings

Declaration
public static string RenderKeybindings(Keybinding[] bindings, Color builtinColor, Color builtinForegroundColor, Color builtinBackgroundColor, Color optionColor, Color optionForegroundColor, Color optionBackgroundColor, Color backgroundColor, int left = 0, int top = 0, int rightMargin = 0, ConsoleKeyInfo? helpKeyInfo = null)
Parameters
Type Name Description
Keybinding[] bindings

List of keybindings (without the builtin ones)
Color builtinColor

Built-in keybinding foreground color in the background color
Color builtinForegroundColor

Built-in keybinding foreground color out of the background color
Color builtinBackgroundColor

Built-in keybinding background color
Color optionColor

Option keybinding foreground color in the background color
Color optionForegroundColor

Option keybinding foreground color out of the background color
Color optionBackgroundColor

Option keybinding background color
Color backgroundColor

Background color
int left

Left position of the keybinding group
int top

Top position of the keybinding group
int rightMargin

Right margin of the keybinding group
ConsoleKeyInfo? helpKeyInfo

Key information that opens the help page
Returns
Type Description
string

Keybindings sequence that you can use with WriteRaw(string, params object[])
| Edit this page View Source

RenderKeybindings(Keybinding[], Keybinding[], int, int, int, ConsoleKeyInfo?)

Renders the keybindings

Declaration
public static string RenderKeybindings(Keybinding[] bindings, Keybinding[] builtinKeybindings, int left = 0, int top = 0, int rightMargin = 0, ConsoleKeyInfo? helpKeyInfo = null)
Parameters
Type Name Description
Keybinding[] bindings

List of keybindings (without the builtin ones)
Keybinding[] builtinKeybindings

List of builtin keybindings
int left

Left position of the keybinding group
int top

Top position of the keybinding group
int rightMargin

Right margin of the keybinding group
ConsoleKeyInfo? helpKeyInfo

Key information that opens the help page
Returns
Type Description
string

Keybindings sequence that you can use with WriteRaw(string, params object[])
| Edit this page View Source

RenderKeybindings(Keybinding[], Keybinding[], Color, int, int, int, ConsoleKeyInfo?)

Renders the keybindings

Declaration
public static string RenderKeybindings(Keybinding[] bindings, Keybinding[] builtinKeybindings, Color backgroundColor, int left = 0, int top = 0, int rightMargin = 0, ConsoleKeyInfo? helpKeyInfo = null)
Parameters
Type Name Description
Keybinding[] bindings

List of keybindings (without the builtin ones)
Keybinding[] builtinKeybindings

List of builtin keybindings
Color backgroundColor

Background color
int left

Left position of the keybinding group
int top

Top position of the keybinding group
int rightMargin

Right margin of the keybinding group
ConsoleKeyInfo? helpKeyInfo

Key information that opens the help page
Returns
Type Description
string

Keybindings sequence that you can use with WriteRaw(string, params object[])
| Edit this page View Source

RenderKeybindings(Keybinding[], Keybinding[], Color, Color, Color, Color, Color, Color, int, int, int, ConsoleKeyInfo?)

Renders the keybindings

Declaration
public static string RenderKeybindings(Keybinding[] bindings, Keybinding[] builtinKeybindings, Color builtinColor, Color builtinForegroundColor, Color builtinBackgroundColor, Color optionColor, Color optionForegroundColor, Color optionBackgroundColor, int left = 0, int top = 0, int rightMargin = 0, ConsoleKeyInfo? helpKeyInfo = null)
Parameters
Type Name Description
Keybinding[] bindings

List of keybindings (without the builtin ones)
Keybinding[] builtinKeybindings

List of builtin keybindings
Color builtinColor

Built-in keybinding foreground color in the background color
Color builtinForegroundColor

Built-in keybinding foreground color out of the background color
Color builtinBackgroundColor

Built-in keybinding background color
Color optionColor

Option keybinding foreground color in the background color
Color optionForegroundColor

Option keybinding foreground color out of the background color
Color optionBackgroundColor

Option keybinding background color
int left

Left position of the keybinding group
int top

Top position of the keybinding group
int rightMargin

Right margin of the keybinding group
ConsoleKeyInfo? helpKeyInfo

Key information that opens the help page
Returns
Type Description
string

Keybindings sequence that you can use with WriteRaw(string, params object[])
| Edit this page View Source

RenderKeybindings(Keybinding[], Keybinding[], Color, Color, Color, Color, Color, Color, Color, int, int, int, ConsoleKeyInfo?)

Renders the keybindings

Declaration
public static string RenderKeybindings(Keybinding[] bindings, Keybinding[] builtinKeybindings, Color builtinColor, Color builtinForegroundColor, Color builtinBackgroundColor, Color optionColor, Color optionForegroundColor, Color optionBackgroundColor, Color backgroundColor, int left = 0, int top = 0, int rightMargin = 0, ConsoleKeyInfo? helpKeyInfo = null)
Parameters
Type Name Description
Keybinding[] bindings

List of keybindings (without the builtin ones)
Keybinding[] builtinKeybindings

List of builtin keybindings
Color builtinColor

Built-in keybinding foreground color in the background color
Color builtinForegroundColor

Built-in keybinding foreground color out of the background color
Color builtinBackgroundColor

Built-in keybinding background color
Color optionColor

Option keybinding foreground color in the background color
Color optionForegroundColor

Option keybinding foreground color out of the background color
Color optionBackgroundColor

Option keybinding background color
Color backgroundColor

Background color
int left

Left position of the keybinding group
int top

Top position of the keybinding group
int rightMargin

Right margin of the keybinding group
ConsoleKeyInfo? helpKeyInfo

Key information that opens the help page
Returns
Type Description
string

Keybindings sequence that you can use with WriteRaw(string, params object[])
| Edit this page View Source

WriteKeybindings(Keybinding[], int, int, int, ConsoleKeyInfo?)

Writes the keybindings

Declaration
public static void WriteKeybindings(Keybinding[] bindings, int left = 0, int top = 0, int rightMargin = 0, ConsoleKeyInfo? helpKeyInfo = null)
Parameters
Type Name Description
Keybinding[] bindings

List of keybindings (without the builtin ones)
int left

Left position of the keybinding group
int top

Top position of the keybinding group
int rightMargin

Right margin of the keybinding group
ConsoleKeyInfo? helpKeyInfo

Key information that opens the help page
| Edit this page View Source

WriteKeybindings(Keybinding[], Color, int, int, int, ConsoleKeyInfo?)

Writes the keybindings

Declaration
public static void WriteKeybindings(Keybinding[] bindings, Color backgroundColor, int left = 0, int top = 0, int rightMargin = 0, ConsoleKeyInfo? helpKeyInfo = null)
Parameters
Type Name Description
Keybinding[] bindings

List of keybindings (without the builtin ones)
Color backgroundColor

Background color
int left

Left position of the keybinding group
int top

Top position of the keybinding group
int rightMargin

Right margin of the keybinding group
ConsoleKeyInfo? helpKeyInfo

Key information that opens the help page
| Edit this page View Source

WriteKeybindings(Keybinding[], Color, Color, Color, Color, Color, Color, int, int, int, ConsoleKeyInfo?)

Writes the keybindings

Declaration
public static void WriteKeybindings(Keybinding[] bindings, Color builtinColor, Color builtinForegroundColor, Color builtinBackgroundColor, Color optionColor, Color optionForegroundColor, Color optionBackgroundColor, int left = 0, int top = 0, int rightMargin = 0, ConsoleKeyInfo? helpKeyInfo = null)
Parameters
Type Name Description
Keybinding[] bindings

List of keybindings (without the builtin ones)
Color builtinColor

Built-in keybinding foreground color in the background color
Color builtinForegroundColor

Built-in keybinding foreground color out of the background color
Color builtinBackgroundColor

Built-in keybinding background color
Color optionColor

Option keybinding foreground color in the background color
Color optionForegroundColor

Option keybinding foreground color out of the background color
Color optionBackgroundColor

Option keybinding background color
int left

Left position of the keybinding group
int top

Top position of the keybinding group
int rightMargin

Right margin of the keybinding group
ConsoleKeyInfo? helpKeyInfo

Key information that opens the help page
| Edit this page View Source

WriteKeybindings(Keybinding[], Color, Color, Color, Color, Color, Color, Color, int, int, int, ConsoleKeyInfo?)

Writes the keybindings

Declaration
public static void WriteKeybindings(Keybinding[] bindings, Color builtinColor, Color builtinForegroundColor, Color builtinBackgroundColor, Color optionColor, Color optionForegroundColor, Color optionBackgroundColor, Color backgroundColor, int left = 0, int top = 0, int rightMargin = 0, ConsoleKeyInfo? helpKeyInfo = null)
Parameters
Type Name Description
Keybinding[] bindings

List of keybindings (without the builtin ones)
Color builtinColor

Built-in keybinding foreground color in the background color
Color builtinForegroundColor

Built-in keybinding foreground color out of the background color
Color builtinBackgroundColor

Built-in keybinding background color
Color optionColor

Option keybinding foreground color in the background color
Color optionForegroundColor

Option keybinding foreground color out of the background color
Color optionBackgroundColor

Option keybinding background color
Color backgroundColor

Background color
int left

Left position of the keybinding group
int top

Top position of the keybinding group
int rightMargin

Right margin of the keybinding group
ConsoleKeyInfo? helpKeyInfo

Key information that opens the help page
| Edit this page View Source

WriteKeybindings(Keybinding[], Keybinding[], int, int, int, ConsoleKeyInfo?)

Writes the keybindings

Declaration
public static void WriteKeybindings(Keybinding[] bindings, Keybinding[] builtinKeybindings, int left = 0, int top = 0, int rightMargin = 0, ConsoleKeyInfo? helpKeyInfo = null)
Parameters
Type Name Description
Keybinding[] bindings

List of keybindings (without the builtin ones)
Keybinding[] builtinKeybindings

List of builtin keybindings
int left

Left position of the keybinding group
int top

Top position of the keybinding group
int rightMargin

Right margin of the keybinding group
ConsoleKeyInfo? helpKeyInfo

Key information that opens the help page
| Edit this page View Source

WriteKeybindings(Keybinding[], Keybinding[], Color, int, int, int, ConsoleKeyInfo?)

Writes the keybindings

Declaration
public static void WriteKeybindings(Keybinding[] bindings, Keybinding[] builtinKeybindings, Color backgroundColor, int left = 0, int top = 0, int rightMargin = 0, ConsoleKeyInfo? helpKeyInfo = null)
Parameters
Type Name Description
Keybinding[] bindings

List of keybindings (without the builtin ones)
Keybinding[] builtinKeybindings

List of builtin keybindings
Color backgroundColor

Background color
int left

Left position of the keybinding group
int top

Top position of the keybinding group
int rightMargin

Right margin of the keybinding group
ConsoleKeyInfo? helpKeyInfo

Key information that opens the help page
| Edit this page View Source

WriteKeybindings(Keybinding[], Keybinding[], Color, Color, Color, Color, Color, Color, int, int, int, ConsoleKeyInfo?)

Writes the keybindings

Declaration
public static void WriteKeybindings(Keybinding[] bindings, Keybinding[] builtinKeybindings, Color builtinColor, Color builtinForegroundColor, Color builtinBackgroundColor, Color optionColor, Color optionForegroundColor, Color optionBackgroundColor, int left = 0, int top = 0, int rightMargin = 0, ConsoleKeyInfo? helpKeyInfo = null)
Parameters
Type Name Description
Keybinding[] bindings

List of keybindings (without the builtin ones)
Keybinding[] builtinKeybindings

List of builtin keybindings
Color builtinColor

Built-in keybinding foreground color in the background color
Color builtinForegroundColor

Built-in keybinding foreground color out of the background color
Color builtinBackgroundColor

Built-in keybinding background color
Color optionColor

Option keybinding foreground color in the background color
Color optionForegroundColor

Option keybinding foreground color out of the background color
Color optionBackgroundColor

Option keybinding background color
int left

Left position of the keybinding group
int top

Top position of the keybinding group
int rightMargin

Right margin of the keybinding group
ConsoleKeyInfo? helpKeyInfo

Key information that opens the help page
| Edit this page View Source

WriteKeybindings(Keybinding[], Keybinding[], Color, Color, Color, Color, Color, Color, Color, int, int, int, ConsoleKeyInfo?)

Writes the keybindings

Declaration
public static void WriteKeybindings(Keybinding[] bindings, Keybinding[] builtinKeybindings, Color builtinColor, Color builtinForegroundColor, Color builtinBackgroundColor, Color optionColor, Color optionForegroundColor, Color optionBackgroundColor, Color backgroundColor, int left = 0, int top = 0, int rightMargin = 0, ConsoleKeyInfo? helpKeyInfo = null)
Parameters
Type Name Description
Keybinding[] bindings

List of keybindings (without the builtin ones)
Keybinding[] builtinKeybindings

List of builtin keybindings
Color builtinColor

Built-in keybinding foreground color in the background color
Color builtinForegroundColor

Built-in keybinding foreground color out of the background color
Color builtinBackgroundColor

Built-in keybinding background color
Color optionColor

Option keybinding foreground color in the background color
Color optionForegroundColor

Option keybinding foreground color out of the background color
Color optionBackgroundColor

Option keybinding background color
Color backgroundColor

Background color
int left

Left position of the keybinding group
int top

Top position of the keybinding group
int rightMargin

Right margin of the keybinding group
ConsoleKeyInfo? helpKeyInfo

Key information that opens the help page