Class InteractiveTuiSettings

Interactive TUI settings

Inheritance

object

InteractiveTuiSettings

Namespace

Terminaux.Inputs.Interactive @ Terminaux.dll

Syntax

public class InteractiveTuiSettings

Constructors

InteractiveTuiSettings()

Makes a new instance of the interactive TUI settings

Declaration

public InteractiveTuiSettings()

InteractiveTuiSettings(InteractiveTuiSettings)

Makes a new instance of the interactive TUI settings with the copied settings

Declaration

public InteractiveTuiSettings(InteractiveTuiSettings settings)

Parameters

Name	Type	Description
settings	InteractiveTuiSettings	Settings instance to copy settings from

Properties

BackgroundColor

Interactive TUI background color

Property Value

Color

Declaration

public Color BackgroundColor { get; set; }

BoxBackgroundColor

Interactive TUI box background color

Property Value

Color

Declaration

public Color BoxBackgroundColor { get; set; }

BoxForegroundColor

Interactive TUI box foreground color

Property Value

Color

Declaration

public Color BoxForegroundColor { get; set; }

ForegroundColor

Interactive TUI foreground color

Property Value

Color

Declaration

public Color ForegroundColor { get; set; }

GlobalSettings

Global interactive TUI settings

Property Value

InteractiveTuiSettings

Declaration

public static InteractiveTuiSettings GlobalSettings { get; }

InfoBoxSettings

Infobox settings to use when rendering the interactive TUI

Property Value

InfoBoxSettings

Declaration

public InfoBoxSettings InfoBoxSettings { get; set; }

KeyBindingBuiltinBackgroundColor

Interactive TUI built-in key binding background color

Property Value

Color

Declaration

public Color KeyBindingBuiltinBackgroundColor { get; set; }

KeyBindingBuiltinColor

Interactive TUI built-in key binding foreground color in the background color

Property Value

Color

Declaration

public Color KeyBindingBuiltinColor { get; set; }

KeyBindingBuiltinForegroundColor

Interactive TUI built-in key binding foreground color outside the background color

Property Value

Color

Declaration

public Color KeyBindingBuiltinForegroundColor { get; set; }

KeyBindingOptionColor

Interactive TUI key binding in option color

Property Value

Color

Declaration

public Color KeyBindingOptionColor { get; set; }

OptionBackgroundColor

Interactive TUI option background color

Property Value

Color

Declaration

public Color OptionBackgroundColor { get; set; }

OptionForegroundColor

Interactive TUI option foreground color

Property Value

Color

Declaration

public Color OptionForegroundColor { get; set; }

PaneBackgroundColor

Interactive TUI pane background color

Property Value

Color

Declaration

public Color PaneBackgroundColor { get; set; }

PaneItemBackColor

Interactive TUI pane item color (background)

Property Value

Color

Declaration

public Color PaneItemBackColor { get; set; }

PaneItemForeColor

Interactive TUI pane item color (foreground)

Property Value

Color

Declaration

public Color PaneItemForeColor { get; set; }

PaneSelectedItemBackColor

Interactive TUI pane selected item color (background)

Property Value

Color

Declaration

public Color PaneSelectedItemBackColor { get; set; }

PaneSelectedItemForeColor

Interactive TUI pane selected item color (foreground)

Property Value

Color

Declaration

public Color PaneSelectedItemForeColor { get; set; }

PaneSelectedSeparatorColor

Interactive TUI pane selected separator color

Property Value

Color

Declaration

public Color PaneSelectedSeparatorColor { get; set; }

PaneSeparatorColor

Interactive TUI pane separator color

Property Value

Color

Declaration

public Color PaneSeparatorColor { get; set; }

Methods

SetBackgroundColor(Color?)

Sets the background color of the interactive TUI

Declaration

public void SetBackgroundColor(Color? color)

Parameters

Name	Type	Description
color	Color	Color to set. If null, inherits the color from the theme.

SetBoxBackgroundColor(Color?)

Sets the box background color of the interactive TUI

Declaration

public void SetBoxBackgroundColor(Color? color)

Parameters

Name	Type	Description
color	Color	Color to set. If null, inherits the color from the theme.

SetBoxForegroundColor(Color?)

Sets the box foreground color of the interactive TUI

Declaration

public void SetBoxForegroundColor(Color? color)

Parameters

Name	Type	Description
color	Color	Color to set. If null, inherits the color from the theme.

SetForegroundColor(Color?)

Sets the foreground color of the interactive TUI

Declaration

public void SetForegroundColor(Color? color)

Parameters

Name	Type	Description
color	Color	Color to set. If null, inherits the color from the theme.

SetKeyBindingBuiltinBackgroundColor(Color?)

Sets the built-in key binding background color of the interactive TUI

Declaration

public void SetKeyBindingBuiltinBackgroundColor(Color? color)

Parameters

Name	Type	Description
color	Color	Color to set. If null, inherits the color from the theme.

SetKeyBindingBuiltinColor(Color?)

Sets the built-in key binding foreground color in the background color of the interactive TUI

Declaration

public void SetKeyBindingBuiltinColor(Color? color)

Parameters

Name	Type	Description
color	Color	Color to set. If null, inherits the color from the theme.

SetKeyBindingBuiltinForegroundColor(Color?)

Sets the built-in key binding foreground color outside the background color of the interactive TUI

Declaration

public void SetKeyBindingBuiltinForegroundColor(Color? color)

Parameters

Name	Type	Description
color	Color	Color to set. If null, inherits the color from the theme.

SetKeyBindingOptionColor(Color?)

Sets the key binding in option color of the interactive TUI

Declaration

public void SetKeyBindingOptionColor(Color? color)

Parameters

Name	Type	Description
color	Color	Color to set. If null, inherits the color from the theme.

SetOptionBackgroundColor(Color?)

Sets the option background color of the interactive TUI

Declaration

public void SetOptionBackgroundColor(Color? color)

Parameters

Name	Type	Description
color	Color	Color to set. If null, inherits the color from the theme.

SetOptionForegroundColor(Color?)

Sets the option foreground color of the interactive TUI

Declaration

public void SetOptionForegroundColor(Color? color)

Parameters

Name	Type	Description
color	Color	Color to set. If null, inherits the color from the theme.

SetPaneBackgroundColor(Color?)

Sets the pane background color of the interactive TUI

Declaration

public void SetPaneBackgroundColor(Color? color)

Parameters

Name	Type	Description
color	Color	Color to set. If null, inherits the color from the theme.

SetPaneItemBackColor(Color?)

Sets the pane item background color of the interactive TUI

Declaration

public void SetPaneItemBackColor(Color? color)

Parameters

Name	Type	Description
color	Color	Color to set. If null, inherits the color from the theme.

SetPaneItemForeColor(Color?)

Sets the pane item foreground color of the interactive TUI

Declaration

public void SetPaneItemForeColor(Color? color)

Parameters

Name	Type	Description
color	Color	Color to set. If null, inherits the color from the theme.

SetPaneSelectedItemBackColor(Color?)

Sets the pane selected item background color of the interactive TUI

Declaration

public void SetPaneSelectedItemBackColor(Color? color)

Parameters

Name	Type	Description
color	Color	Color to set. If null, inherits the color from the theme.

SetPaneSelectedItemForeColor(Color?)

Sets the pane selected item foreground color of the interactive TUI

Declaration

public void SetPaneSelectedItemForeColor(Color? color)

Parameters

Name	Type	Description
color	Color	Color to set. If null, inherits the color from the theme.

SetPaneSelectedSeparatorColor(Color?)

Sets the pane selected separator color of the interactive TUI

Declaration

public void SetPaneSelectedSeparatorColor(Color? color)

Parameters

Name	Type	Description
color	Color	Color to set. If null, inherits the color from the theme.

SetPaneSeparatorColor(Color?)

Sets the pane separator color of the interactive TUI

Declaration

public void SetPaneSeparatorColor(Color? color)

Parameters

Name	Type	Description
color	Color	Color to set. If null, inherits the color from the theme.