Class CheckBoxTableSourceWrapperBase

Namespace

Terminal.Gui

Assembly

Terminal.Gui.dll

ITableSource for a TableView which adds a checkbox column as an additional column in the table.

public abstract class CheckBoxTableSourceWrapperBase : ITableSource

Inheritance

object

CheckBoxTableSourceWrapperBase

Implements

ITableSource

Derived

CheckBoxTableSourceWrapperByIndex

CheckBoxTableSourceWrapperByObject<T>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

This class wraps another ITableSource and dynamically serves its rows/cols plus an extra column. Data in the wrapped source can be dynamic (change over time).

Constructors

CheckBoxTableSourceWrapperBase(TableView, ITableSource)

Creates a new instance of the class presenting the data in toWrap plus an additional checkbox column.

Properties

CheckedRune

Gets or sets the character to use for checked entries. Defaults to CheckStateChecked

ColumnNames

Gets the label for each column.

Columns

Gets the number of columns in the table.

this[int, int]

Returns the data at the given indexes of the table (row, column).

RadioCheckedRune

Gets or sets the character to use for checked entry when UseRadioButtons is true. Defaults to Selected

RadioUnCheckedRune

Gets or sets the character to use for unchecked entries when UseRadioButtons is true. Defaults to UnSelected

Rows

Gets the number of rows in the table.

UnCheckedRune

Gets or sets the character to use for UnChecked entries. Defaults to CheckStateUnChecked

UseRadioButtons

Gets or sets whether to only allow a single row to be toggled at once (Radio button).

Wrapping

Gets the ITableSource that this instance is wrapping.

Methods

ClearAllToggles()

Clears the toggled state of all rows.

IsChecked(int)

Returns true if row is checked.

ToggleAllRows()

Called when the 'toggled all' action is performed. This should change state from 'some selected' to 'all selected' or clear selection if all area already selected.

ToggleRow(int)

Flips the checked state of the given row/

ToggleRows(int[])

Flips the checked state for a collection of rows. If some (but not all) are selected they should flip to all selected.