Class KeybindingTools

Keybinding tools

Inheritance

object

KeybindingTools

Namespace: Terminaux.Writer.CyclicWriters.Renderer.Tools

Assembly: Terminaux.dll

Syntax

public static class KeybindingTools

Methods

| Edit this page View Source

RenderKeybindingHelpText(Keybinding[])

Renders the keybinding help text

Declaration

public static string RenderKeybindingHelpText(Keybinding[] keybindings)

Parameters

Type	Name	Description
Keybinding[]	keybindings	Keybindings (including the built-in ones)

Returns

Type	Description
string	Rendered keybindings help text that you can render for infoboxes.

| Edit this page View Source

ShowKeybindingInfobox(string, Keybinding[], params object[])

Writes the info box plainly

Declaration

[Obsolete("This legacy function is to be removed from the final release of Terminaux 7.0. While you can use this in Beta 3, please move all settings to InfoBoxSettings. This is done to clean up the legacy codebase.")]
public static void ShowKeybindingInfobox(string title, Keybinding[] keybindings, params object[] vars)

Parameters

Type	Name	Description
string	title	Title to be written
Keybinding[]	keybindings	Keybindings (including the built-in ones)
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

ShowKeybindingInfobox(string, Keybinding[], BorderSettings, params object[])

Writes the info box plainly

Declaration

[Obsolete("This legacy function is to be removed from the final release of Terminaux 7.0. While you can use this in Beta 3, please move all settings to InfoBoxSettings. This is done to clean up the legacy codebase.")]
public static void ShowKeybindingInfobox(string title, Keybinding[] keybindings, BorderSettings settings, params object[] vars)

Parameters

Type	Name	Description
string	title	Title to be written
Keybinding[]	keybindings	Keybindings (including the built-in ones)
BorderSettings	settings	Border settings to use
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

ShowKeybindingInfobox(Keybinding[], params object[])

Shows the keybinding information box

Declaration

public static void ShowKeybindingInfobox(Keybinding[] keybindings, params object[] vars)

Parameters

Type	Name	Description
Keybinding[]	keybindings	Keybindings (including the built-in ones)
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

ShowKeybindingInfobox(Keybinding[], InfoBoxSettings, params object[])

Shows the keybinding information box

Declaration

public static void ShowKeybindingInfobox(Keybinding[] keybindings, InfoBoxSettings settings, params object[] vars)

Parameters

Type	Name	Description
Keybinding[]	keybindings	Keybindings (including the built-in ones)
InfoBoxSettings	settings	Infobox settings to use
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

ShowKeybindingInfobox(Keybinding[], BorderSettings, params object[])

Writes the info box plainly

Declaration

[Obsolete("This legacy function is to be removed from the final release of Terminaux 7.0. While you can use this in Beta 3, please move all settings to InfoBoxSettings. This is done to clean up the legacy codebase.")]
public static void ShowKeybindingInfobox(Keybinding[] keybindings, BorderSettings settings, params object[] vars)

Parameters

Type	Name	Description
Keybinding[]	keybindings	Keybindings (including the built-in ones)
BorderSettings	settings	Border settings to use
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

ShowKeybindingInfoboxColor(string, Keybinding[], Color, params object[])

Writes the info box plainly

Declaration

[Obsolete("This legacy function is to be removed from the final release of Terminaux 7.0. While you can use this in Beta 3, please move all settings to InfoBoxSettings. This is done to clean up the legacy codebase.")]
public static void ShowKeybindingInfoboxColor(string title, Keybinding[] keybindings, Color InfoBoxTitledColor, params object[] vars)

Parameters

Type	Name	Description
string	title	Title to be written
Keybinding[]	keybindings	Keybindings (including the built-in ones)
Color	InfoBoxTitledColor	InfoBoxTitled color
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

ShowKeybindingInfoboxColor(string, Keybinding[], BorderSettings, Color, params object[])

Writes the info box plainly

Declaration

[Obsolete("This legacy function is to be removed from the final release of Terminaux 7.0. While you can use this in Beta 3, please move all settings to InfoBoxSettings. This is done to clean up the legacy codebase.")]
public static void ShowKeybindingInfoboxColor(string title, Keybinding[] keybindings, BorderSettings settings, Color InfoBoxTitledColor, params object[] vars)

Parameters

Type	Name	Description
string	title	Title to be written
Keybinding[]	keybindings	Keybindings (including the built-in ones)
BorderSettings	settings	Border settings to use
Color	InfoBoxTitledColor	InfoBoxTitled color
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

ShowKeybindingInfoboxColor(Keybinding[], Color, params object[])

Writes the info box plainly

Declaration

[Obsolete("This legacy function is to be removed from the final release of Terminaux 7.0. While you can use this in Beta 3, please move all settings to InfoBoxSettings. This is done to clean up the legacy codebase.")]
public static void ShowKeybindingInfoboxColor(Keybinding[] keybindings, Color InfoBoxColor, params object[] vars)

Parameters

Type	Name	Description
Keybinding[]	keybindings	Keybindings (including the built-in ones)
Color	InfoBoxColor	InfoBox color
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

ShowKeybindingInfoboxColor(Keybinding[], BorderSettings, Color, params object[])

Writes the info box plainly

Declaration

[Obsolete("This legacy function is to be removed from the final release of Terminaux 7.0. While you can use this in Beta 3, please move all settings to InfoBoxSettings. This is done to clean up the legacy codebase.")]
public static void ShowKeybindingInfoboxColor(Keybinding[] keybindings, BorderSettings settings, Color InfoBoxColor, params object[] vars)

Parameters

Type	Name	Description
Keybinding[]	keybindings	Keybindings (including the built-in ones)
BorderSettings	settings	Border settings to use
Color	InfoBoxColor	InfoBox color
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

ShowKeybindingInfoboxColorBack(string, Keybinding[], Color, Color, params object[])

Writes the info box plainly

Declaration

[Obsolete("This legacy function is to be removed from the final release of Terminaux 7.0. While you can use this in Beta 3, please move all settings to InfoBoxSettings. This is done to clean up the legacy codebase.")]
public static void ShowKeybindingInfoboxColorBack(string title, Keybinding[] keybindings, Color InfoBoxTitledColor, Color BackgroundColor, params object[] vars)

Parameters

Type	Name	Description
string	title	Title to be written
Keybinding[]	keybindings	Keybindings (including the built-in ones)
Color	InfoBoxTitledColor	InfoBoxTitled color
Color	BackgroundColor	InfoBoxTitled background color
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

ShowKeybindingInfoboxColorBack(string, Keybinding[], BorderSettings, Color, Color, params object[])

Writes the info box plainly

Declaration

[Obsolete("This legacy function is to be removed from the final release of Terminaux 7.0. While you can use this in Beta 3, please move all settings to InfoBoxSettings. This is done to clean up the legacy codebase.")]
public static void ShowKeybindingInfoboxColorBack(string title, Keybinding[] keybindings, BorderSettings settings, Color InfoBoxTitledColor, Color BackgroundColor, params object[] vars)

Parameters

Type	Name	Description
string	title	Title to be written
Keybinding[]	keybindings	Keybindings (including the built-in ones)
BorderSettings	settings	Border settings to use
Color	InfoBoxTitledColor	InfoBoxTitled color
Color	BackgroundColor	InfoBoxTitled background color
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

ShowKeybindingInfoboxColorBack(Keybinding[], Color, Color, params object[])

Writes the info box plainly

Declaration

[Obsolete("This legacy function is to be removed from the final release of Terminaux 7.0. While you can use this in Beta 3, please move all settings to InfoBoxSettings. This is done to clean up the legacy codebase.")]
public static void ShowKeybindingInfoboxColorBack(Keybinding[] keybindings, Color InfoBoxColor, Color BackgroundColor, params object[] vars)

Parameters

Type	Name	Description
Keybinding[]	keybindings	Keybindings (including the built-in ones)
Color	InfoBoxColor	InfoBox color
Color	BackgroundColor	InfoBox background color
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

ShowKeybindingInfoboxColorBack(Keybinding[], BorderSettings, Color, Color, params object[])

Writes the info box plainly

Declaration

[Obsolete("This legacy function is to be removed from the final release of Terminaux 7.0. While you can use this in Beta 3, please move all settings to InfoBoxSettings. This is done to clean up the legacy codebase.")]
public static void ShowKeybindingInfoboxColorBack(Keybinding[] keybindings, BorderSettings settings, Color InfoBoxColor, Color BackgroundColor, params object[] vars)

Parameters

Type	Name	Description
Keybinding[]	keybindings	Keybindings (including the built-in ones)
BorderSettings	settings	Border settings to use
Color	InfoBoxColor	InfoBox color
Color	BackgroundColor	InfoBox background color
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

ShowKeybindingInfoboxPlain(string, Keybinding[], params object[])

Writes the info box plainly

Declaration

[Obsolete("This legacy function is to be removed from the final release of Terminaux 7.0. While you can use this in Beta 3, please move all settings to InfoBoxSettings. This is done to clean up the legacy codebase.")]
public static void ShowKeybindingInfoboxPlain(string title, Keybinding[] keybindings, params object[] vars)

Parameters

Type	Name	Description
string	title	Title to be written
Keybinding[]	keybindings	Keybindings (including the built-in ones)
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

ShowKeybindingInfoboxPlain(string, Keybinding[], BorderSettings, params object[])

Writes the info box plainly

Declaration

[Obsolete("This legacy function is to be removed from the final release of Terminaux 7.0. While you can use this in Beta 3, please move all settings to InfoBoxSettings. This is done to clean up the legacy codebase.")]
public static void ShowKeybindingInfoboxPlain(string title, Keybinding[] keybindings, BorderSettings settings, params object[] vars)

Parameters

Type	Name	Description
string	title	Title to be written
Keybinding[]	keybindings	Keybindings (including the built-in ones)
BorderSettings	settings	Border settings to use
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

ShowKeybindingInfoboxPlain(Keybinding[], params object[])

Writes the info box plainly

Declaration

[Obsolete("This legacy function is to be removed from the final release of Terminaux 7.0. While you can use this in Beta 3, please move all settings to InfoBoxSettings. This is done to clean up the legacy codebase.")]
public static void ShowKeybindingInfoboxPlain(Keybinding[] keybindings, params object[] vars)

Parameters

Type	Name	Description
Keybinding[]	keybindings	Keybindings (including the built-in ones)
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

ShowKeybindingInfoboxPlain(Keybinding[], BorderSettings, params object[])

Writes the info box plainly

Declaration

[Obsolete("This legacy function is to be removed from the final release of Terminaux 7.0. While you can use this in Beta 3, please move all settings to InfoBoxSettings. This is done to clean up the legacy codebase.")]
public static void ShowKeybindingInfoboxPlain(Keybinding[] keybindings, BorderSettings settings, params object[] vars)

Parameters

Type	Name	Description
Keybinding[]	keybindings	Keybindings (including the built-in ones)
BorderSettings	settings	Border settings to use
object[]	vars	Variables to format the message before it's written.