Class SelectionInputTools

Selection style input tools

Inheritance
object
SelectionInputTools
Namespace: Terminaux.Inputs.Styles.Selection
Assembly: Terminaux.dll
Syntax
public static class SelectionInputTools

Methods

| Edit this page View Source

RenderSelections(InputChoiceCategoryInfo[], int, int, int, int, int, bool, int, bool, Color?, Color?, Color?, Color?, Color?, Color?, Color?, Color?, Color?, Color?)

Renders the selections to the console

Declaration
[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 string RenderSelections(InputChoiceCategoryInfo[] selections, int left, int top, int currentSelection, int selectionChoices, int width, bool sliderInside = false, int altChoicePos = -1, bool swapSelectedColors = true, Color? foregroundColor = null, Color? backgroundColor = null, Color? selectedForegroundColor = null, Color? selectedBackgroundColor = null, Color? altForegroundColor = null, Color? altBackgroundColor = null, Color? altSelectedForegroundColor = null, Color? altSelectedBackgroundColor = null, Color? disabledForegroundColor = null, Color? disabledBackgroundColor = null)
Parameters
Type Name Description
InputChoiceCategoryInfo[] selections

The selection choices
int left

Left position of the selection box (upper left corner, zero-based)
int top

Top position of the selection box (upper left corner, zero-based)
int currentSelection

Zero-based current choice selection
int selectionChoices

How many choices to render to the selection box? One-based.
int width

Width of the selection box (zero-based)
bool sliderInside

Whether to render the slider inside the box or outside the box
int altChoicePos

Alternate choice position (zero-based)
bool swapSelectedColors

Whether to swap the selected choice colors or not
Color foregroundColor

Foreground color of the unselected item
Color backgroundColor

Background color of the unselected item
Color selectedForegroundColor

Foreground color of the selected item
Color selectedBackgroundColor

Background color of the selected item
Color altForegroundColor

Foreground color of the unselected alternate item
Color altBackgroundColor

Background color of the unselected alternate item
Color altSelectedForegroundColor

Foreground color of the selected alternate item
Color altSelectedBackgroundColor

Background color of the selected alternate item
Color disabledForegroundColor

Foreground color of the disabled item
Color disabledBackgroundColor

Background color of the disabled item
Returns
Type Description
string

A string that you can use with the raw console writer or with the screen part renderer
Exceptions
Type Condition
TerminauxException
| Edit this page View Source

RenderSelections(InputChoiceCategoryInfo[], int, int, int, int[]?, int, int, bool, int, bool, Color?, Color?, Color?, Color?, Color?, Color?, Color?, Color?, Color?, Color?)

Renders the selections to the console

Declaration
[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 string RenderSelections(InputChoiceCategoryInfo[] selections, int left, int top, int currentSelection, int[]? currentSelections, int selectionChoices, int width, bool sliderInside = false, int altChoicePos = -1, bool swapSelectedColors = true, Color? foregroundColor = null, Color? backgroundColor = null, Color? selectedForegroundColor = null, Color? selectedBackgroundColor = null, Color? altForegroundColor = null, Color? altBackgroundColor = null, Color? altSelectedForegroundColor = null, Color? altSelectedBackgroundColor = null, Color? disabledForegroundColor = null, Color? disabledBackgroundColor = null)
Parameters
Type Name Description
InputChoiceCategoryInfo[] selections

The selection choices
int left

Left position of the selection box (upper left corner, zero-based)
int top

Top position of the selection box (upper left corner, zero-based)
int currentSelection

Zero-based current choice selection
int[] currentSelections

List of zero-based current selection numbers (for multiple choice selection)
int selectionChoices

How many choices to render to the selection box? One-based.
int width

Width of the selection box (zero-based)
bool sliderInside

Whether to render the slider inside the box or outside the box
int altChoicePos

Alternate choice position (zero-based)
bool swapSelectedColors

Whether to swap the selected choice colors or not
Color foregroundColor

Foreground color of the unselected item
Color backgroundColor

Background color of the unselected item
Color selectedForegroundColor

Foreground color of the selected item
Color selectedBackgroundColor

Background color of the selected item
Color altForegroundColor

Foreground color of the unselected alternate item
Color altBackgroundColor

Background color of the unselected alternate item
Color altSelectedForegroundColor

Foreground color of the selected alternate item
Color altSelectedBackgroundColor

Background color of the selected alternate item
Color disabledForegroundColor

Foreground color of the disabled item
Color disabledBackgroundColor

Background color of the disabled item
Returns
Type Description
string

A string that you can use with the raw console writer or with the screen part renderer
Exceptions
Type Condition
TerminauxException
| Edit this page View Source

RenderSelections(InputChoiceInfo[], int, int, int, int, int, bool, int, bool, Color?, Color?, Color?, Color?, Color?, Color?, Color?, Color?, Color?, Color?)

Renders the selections to the console

Declaration
[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 string RenderSelections(InputChoiceInfo[] selections, int left, int top, int currentSelection, int selectionChoices, int width, bool sliderInside = false, int altChoicePos = -1, bool swapSelectedColors = true, Color? foregroundColor = null, Color? backgroundColor = null, Color? selectedForegroundColor = null, Color? selectedBackgroundColor = null, Color? altForegroundColor = null, Color? altBackgroundColor = null, Color? altSelectedForegroundColor = null, Color? altSelectedBackgroundColor = null, Color? disabledForegroundColor = null, Color? disabledBackgroundColor = null)
Parameters
Type Name Description
InputChoiceInfo[] selections

The selection choices
int left

Left position of the selection box (upper left corner, zero-based)
int top

Top position of the selection box (upper left corner, zero-based)
int currentSelection

Zero-based current choice selection
int selectionChoices

How many choices to render to the selection box? One-based.
int width

Width of the selection box (zero-based)
bool sliderInside

Whether to render the slider inside the box or outside the box
int altChoicePos

Alternate choice position (zero-based)
bool swapSelectedColors

Whether to swap the selected choice colors or not
Color foregroundColor

Foreground color of the unselected item
Color backgroundColor

Background color of the unselected item
Color selectedForegroundColor

Foreground color of the selected item
Color selectedBackgroundColor

Background color of the selected item
Color altForegroundColor

Foreground color of the unselected alternate item
Color altBackgroundColor

Background color of the unselected alternate item
Color altSelectedForegroundColor

Foreground color of the selected alternate item
Color altSelectedBackgroundColor

Background color of the selected alternate item
Color disabledForegroundColor

Foreground color of the disabled item
Color disabledBackgroundColor

Background color of the disabled item
Returns
Type Description
string

A string that you can use with the raw console writer or with the screen part renderer
Exceptions
Type Condition
TerminauxException
| Edit this page View Source

RenderSelections(InputChoiceInfo[], int, int, int, int[]?, int, int, bool, int, bool, Color?, Color?, Color?, Color?, Color?, Color?, Color?, Color?, Color?, Color?)

Renders the selections to the console

Declaration
[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 string RenderSelections(InputChoiceInfo[] selections, int left, int top, int currentSelection, int[]? currentSelections, int selectionChoices, int width, bool sliderInside = false, int altChoicePos = -1, bool swapSelectedColors = true, Color? foregroundColor = null, Color? backgroundColor = null, Color? selectedForegroundColor = null, Color? selectedBackgroundColor = null, Color? altForegroundColor = null, Color? altBackgroundColor = null, Color? altSelectedForegroundColor = null, Color? altSelectedBackgroundColor = null, Color? disabledForegroundColor = null, Color? disabledBackgroundColor = null)
Parameters
Type Name Description
InputChoiceInfo[] selections

The selection choices
int left

Left position of the selection box (upper left corner, zero-based)
int top

Top position of the selection box (upper left corner, zero-based)
int currentSelection

Zero-based current choice selection
int[] currentSelections

List of zero-based current selection numbers (for multiple choice selection)
int selectionChoices

How many choices to render to the selection box? One-based.
int width

Width of the selection box (zero-based)
bool sliderInside

Whether to render the slider inside the box or outside the box
int altChoicePos

Alternate choice position (zero-based)
bool swapSelectedColors

Whether to swap the selected choice colors or not
Color foregroundColor

Foreground color of the unselected item
Color backgroundColor

Background color of the unselected item
Color selectedForegroundColor

Foreground color of the selected item
Color selectedBackgroundColor

Background color of the selected item
Color altForegroundColor

Foreground color of the unselected alternate item
Color altBackgroundColor

Background color of the unselected alternate item
Color altSelectedForegroundColor

Foreground color of the selected alternate item
Color altSelectedBackgroundColor

Background color of the selected alternate item
Color disabledForegroundColor

Foreground color of the disabled item
Color disabledBackgroundColor

Background color of the disabled item
Returns
Type Description
string

A string that you can use with the raw console writer or with the screen part renderer
Exceptions
Type Condition
TerminauxException