Class TableSelector

Namespace

ConsoleAppVisuals.InteractiveElements

Assembly

ConsoleAppVisuals.dll

The TableSelector is an interactive element that displays a table with selectable elements.

public class TableSelector : InteractiveElement<int>

Inheritance

object

Element

InteractiveElement<int>

TableSelector

Inherited Members

InteractiveElement<int>._interactionResponse

InteractiveElement<int>.SetInteractionResponse(object, InteractionEventArgs<int>)

InteractiveElement<int>.SendResponse(object, InteractionEventArgs<int>)

InteractiveElement<int>.GetResponse()

InteractiveElement<int>.GetResponseHistory()

InteractiveElement<int>.RenderOptionsBeforeHand()

InteractiveElement<int>.RenderOptionsAfterHand()

InteractiveElement<int>.Type

InteractiveElement<int>.MaxNumberOfThisElement

InteractiveElement<int>.EndOfInteractionEvent

Element.ToggleVisibility()

Element.RenderElement()

Element.RenderElementSpace(bool)

Element.GetRenderSpace()

Element.Clear()

Element.Id

Element.Visibility

Element.TextAlignment

Element.Line

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

For more information, consider visiting the documentation available here.

Constructors

TableSelector(string?, List<string>?, List<List<string>>?, bool, bool, string?, Placement, BordersType)

The TableSelector is an interactive element that displays a table with selectable elements.

public TableSelector(string? title = null, List<string>? headers = null, List<List<string>>? lines = null, bool excludeHeader = true, bool excludeFooter = true, string? footerText = null, Placement placement = Placement.TopCenter, BordersType bordersType = BordersType.SingleStraight)

Parameters

title string

The title of the table.

headers List<string>

The headers of the table.

lines List<List<string>>

The lines of the table.

excludeHeader bool

Whether to exclude the header from selectable elements.

excludeFooter bool

Whether to exclude the footer from selectable elements.

footerText string

The text to display in the footer.

placement Placement

The placement of the table.

bordersType BordersType

The type of the borders of the table.

Remarks

For more information, consider visiting the documentation available here.

Exceptions

ArgumentException

Thrown when the number of columns in the table is not consistent with itself or with the headers.

NullReferenceException

Thrown when no body lines were provided.

Properties

Borders

Gets the borders manager of the table.

public Borders Borders { get; }

Property Value

Borders

BordersType

Gets the type of the borders of the table.

public BordersType BordersType { get; }

Property Value

BordersType

Count

Gets the number of lines in the table.

public int Count { get; }

Property Value

int

DisplayArray

Gets the display array of the table.

public string[]? DisplayArray { get; }

Property Value

string[]

ExcludeFooter

Gets if the footer is excluded.

public bool ExcludeFooter { get; }

Property Value

bool

ExcludeHeader

Gets if the header is excluded.

public bool ExcludeHeader { get; }

Property Value

bool

FooterText

Gets the text of the footer.

public string FooterText { get; }

Property Value

string

GetRawHeaders

Gets the headers of the table.

public List<string>? GetRawHeaders { get; }

Property Value

List<string>

GetRawLines

Gets the lines of the table.

public List<List<string>>? GetRawLines { get; }

Property Value

List<List<string>>

Height

Gets the height of the table.

public override int Height { get; }

Property Value

int

Placement

Gets the placement of the table on the console.

public override Placement Placement { get; }

Property Value

Placement

Title

Gets the title of the table.

public string? Title { get; }

Property Value

string

Width

Gets the width of the table.

public override int Width { get; }

Property Value

int

Methods

AddHeaders(List<string>)

Adds headers to the table.

public void AddHeaders(List<string> headers)

Parameters

headers List<string>

The headers to add.

Remarks

For more information, consider visiting the documentation available here.

AddLine(List<string>)

Adds a line to the table.

public void AddLine(List<string> line)

Parameters

line List<string>

The line to add.

Remarks

For more information, consider visiting the documentation available here.

Exceptions

ArgumentException

Thrown when the number of columns in the table is not consistent with itself or with the headers.

AddTitle(string)

Adds a title to the table.

public void AddTitle(string title)

Parameters

title string

The title to add.

Remarks

For more information, consider visiting the documentation available here.

ClearHeaders()

Clears the headers of the table.

public void ClearHeaders()

Remarks

For more information, consider visiting the documentation available here.

ClearLines()

Clears the lines of the table.

public void ClearLines()

Remarks

For more information, consider visiting the documentation available here.

GetColumnData(int)

Gets all the elements from a column given its index.

public List<string>? GetColumnData(int index)

Parameters

index int

The index of the column.

Returns

List<string>

The elements of the column.

Remarks

For more information, consider visiting the documentation available here.

Exceptions

ArgumentOutOfRangeException

Thrown when the index is out of range.

GetColumnData(string)

Gets all the elements from a column given its header.

public List<string>? GetColumnData(string header)

Parameters

header string

The header of the column.

Returns

List<string>

The elements of the column.

Remarks

For more information, consider visiting the documentation available here.

Exceptions

ArgumentException

Thrown when the header is invalid.

GetLine(int)

Gets the specified line in the table.

public List<string> GetLine(int index)

Parameters

index int

The index of the line to return.

Returns

List<string>

The line at the specified index.

Remarks

For more information, consider visiting the documentation available here.

Exceptions

ArgumentOutOfRangeException

Thrown when the index is out of range.

RemoveLine(int)

Removes a line from the table given its index.

public void RemoveLine(int index)

Parameters

index int

The index of the line to remove.

Remarks

For more information, consider visiting the documentation available here.

Exceptions

ArgumentOutOfRangeException

Thrown when the index is out of range.

RenderElementActions()

Defines the actions to perform when the element is called to be rendered on the console.

[Visual]
protected override void RenderElementActions()

Reset()

Clears the table.

public void Reset()

Remarks

For more information, consider visiting the documentation available here.

SetExcludeFooter(bool)

Sets the table to exclude the footer.

public void SetExcludeFooter(bool excludeFooter = true)

Parameters

excludeFooter bool

Whether to exclude the footer or not.

Remarks

For more information, consider visiting the documentation available here.

SetExcludeHeader(bool)

Sets the table to exclude the header.

public void SetExcludeHeader(bool excludeHeader = true)

Parameters

excludeHeader bool

Whether to exclude the header or not.

Remarks

For more information, consider visiting the documentation available here.

UpdateBordersType(BordersType)

Updates the type of the borders of the table.

public void UpdateBordersType(BordersType bordersType)

Parameters

bordersType BordersType

The type of the borders of the table.

Remarks

For more information, consider visiting the documentation available here.

UpdateFooterText(string)

Updates the text of the footer.

public void UpdateFooterText(string footerText)

Parameters

footerText string

The text of the footer.

Remarks

For more information, consider visiting the documentation available here.

UpdateHeaders(List<string>)

Updates the headers of the table.

public void UpdateHeaders(List<string> headers)

Parameters

headers List<string>

The headers to update.

Remarks

For more information, consider visiting the documentation available here.

UpdateLine(int, List<string>)

Updates a line in the table.

public void UpdateLine(int index, List<string> line)

Parameters

index int

The index of the line to update.

line List<string>

The new line.

Remarks

For more information, consider visiting the documentation available here.

Exceptions

ArgumentOutOfRangeException

Thrown when the index is out of range.

ArgumentException

Thrown when the number of columns in the table is not consistent with itself or with the headers.

UpdatePlacement(Placement)

Updates the placement of the table.

public void UpdatePlacement(Placement placement)

Parameters

placement Placement

The placement of the table.

Remarks

For more information, consider visiting the documentation available here.

UpdateTitle(string)

Updates the title of the table.

public void UpdateTitle(string title)

Parameters

title string

The title to update.

Remarks

For more information, consider visiting the documentation available here.