Class Table
A scrollable table control.
Assembly: SadConsole.Extended.dll
Syntax
public class Table : CompositeControl, IContainer, IList<ControlBase>, ICollection<ControlBase>, IEnumerable<ControlBase>, IEnumerable
Constructors
Table(int, int)
Creates a new table with the default SadConsole colors, and cell size of (1 width, 1 height)
Declaration
public Table(int width, int height)
Parameters
| Type |
Name |
Description |
| int |
width |
|
| int |
height |
|
Table(int, int, int, Color, Color, int)
Creates a new table with extra params to set the base default values of the table
Declaration
public Table(int width, int height, int cellWidth, Color defaultForeground, Color defaultBackground, int cellHeight = 1)
Parameters
| Type |
Name |
Description |
| int |
width |
|
| int |
height |
|
| int |
cellWidth |
|
| Color |
defaultForeground |
|
| Color |
defaultBackground |
|
| int |
cellHeight |
|
Table(int, int, int, int)
Creates a new table with custom cell width and cell height params; Uses the default SadConsole colors
Declaration
public Table(int width, int height, int cellWidth, int cellHeight = 1)
Parameters
| Type |
Name |
Description |
| int |
width |
|
| int |
height |
|
| int |
cellWidth |
|
| int |
cellHeight |
|
Properties
By default the table will automatically scroll to the selected cell if possible.
Declaration
public bool AutoScrollOnCellSelection { get; set; }
Property Value
Cells
The cells collection used to modify the table cells
Declaration
public Table.TableCells Cells { get; }
Property Value
CurrentMouseCell
Declaration
public Table.Cell? CurrentMouseCell { get; }
Property Value
DefaultBackground
The default background color used for the table background and newly created cells
Declaration
public Color DefaultBackground { get; set; }
Property Value
DefaultCellSize
The default size a cell gets when it is newly created
Declaration
public Point DefaultCellSize { get; set; }
Property Value
DefaultForeground
The default foreground color used for the table foreground and newly created cells
Declaration
public Color DefaultForeground { get; set; }
Property Value
DefaultHoverMode
The default visual hovering mode when hovering over cells
Declaration
public Table.TableCells.Layout.Mode DefaultHoverMode { get; set; }
Property Value
DefaultSelectionMode
The default visual selection mode when selecting a cell
Declaration
public Table.TableCells.Layout.Mode DefaultSelectionMode { get; set; }
Property Value
DrawFakeCells
By default, only cells that have been modified in anyway will be rendered on the table control.
Turn this off, if the whole table should draw as many cells as it fits with their default layout.
Declaration
public bool DrawFakeCells { get; set; }
Property Value
The horizontal scrollbar, use the SetupScrollBar method with Horizontal orientation to initialize it.
Declaration
public ScrollBar? HorizontalScrollBar { get; }
Property Value
The updated maximum value, incase the scrollbar object's maximum value is not yet updated by the theme.
Declaration
public int HorizontalScrollBarMaximum { get; }
Property Value
Returns true if the horizontal scroll bar is currently visible.
Declaration
public bool IsHorizontalScrollBarVisible { get; }
Property Value
Returns true if the vertical scroll bar is currently visible.
Declaration
public bool IsVerticalScrollBarVisible { get; }
Property Value
SelectedCell
Returns the current selected cell
Declaration
public Table.Cell? SelectedCell { get; }
Property Value
UseMouse
When true, this object will use the mouse; otherwise false.
Declaration
public bool UseMouse { get; set; }
Property Value
The vertical scrollbar, use the SetupScrollBar method with Vertical orientation to initialize it.
Declaration
public ScrollBar? VerticalScrollBar { get; }
Property Value
The updated maximum value, incase the scrollbar object's maximum value is not yet updated by the theme.
Declaration
public int VerticalScrollBarMaximum { get; }
Property Value
Methods
AdjustControlSurface(Cell, ColoredGlyphBase?, bool)
Declaration
protected void AdjustControlSurface(Table.Cell cell, ColoredGlyphBase? customStateAppearance, bool adjustVisibility)
Parameters
GetCustomStateAppearance(Cell)
Declaration
protected ColoredGlyphBase? GetCustomStateAppearance(Table.Cell cell)
Parameters
Returns
GetHorizontalAlignment(HorizontalAlign, int, char[])
Declaration
protected static int GetHorizontalAlignment(Table.Cell.Options.HorizontalAlign hAlign, int totalWidth, char[] textArr)
Parameters
Returns
GetOldRowAndColumnValues(List<((int x, int y), (int row, int col))>?, Point, ref int, ref int)
Declaration
protected void GetOldRowAndColumnValues(List<((int x, int y), (int row, int col))>? fakeCells, Point cellPosition, ref int oldRow, ref int oldCol)
Parameters
GetTotalCellSize(Cell, int, int, out int, out int)
Declaration
protected static void GetTotalCellSize(Table.Cell cell, int width, int height, out int totalWidth, out int totalHeight)
Parameters
HideVisualCell(int, int, Point)
Declaration
protected void HideVisualCell(int column, int row, Point position)
Parameters
| Type |
Name |
Description |
| int |
column |
|
| int |
row |
|
| Point |
position |
|
OnLeftMouseClicked(ControlMouseState)
Called when the left mouse button is clicked. Raises the MouseButtonClicked event and calls the DetermineState() method.
Declaration
protected override void OnLeftMouseClicked(ControlBase.ControlMouseState state)
Parameters
Overrides
OnMouseExit(ControlMouseState)
Called when the mouse exits the area of the control. Raises the MouseExit event and calls the DetermineState() method.
Declaration
protected override void OnMouseExit(ControlBase.ControlMouseState state)
Parameters
Overrides
OnMouseIn(ControlMouseState)
Called as the mouse moves around the control area. Raises the MouseMove event and calls the DetermineState() method.
Declaration
protected override void OnMouseIn(ControlBase.ControlMouseState state)
Parameters
Overrides
OnRightMouseClicked(ControlMouseState)
Called when the right mouse button is clicked. Raises the MouseButtonClicked event and calls the DetermineState() method.
Declaration
protected override void OnRightMouseClicked(ControlBase.ControlMouseState state)
Parameters
Overrides
PrintText(Cell)
Declaration
protected void PrintText(Table.Cell cell)
Parameters
Scrolls the list to the item currently selected.
Declaration
public void ScrollToSelectedItem()
Declaration
protected void SetScrollBarVisibility(int maxRowsHeight, int maxColumnsWidth)
Parameters
| Type |
Name |
Description |
| int |
maxRowsHeight |
|
| int |
maxColumnsWidth |
|
Declaration
public void SetupScrollBar(Orientation orientation, int size, Point position)
Parameters
| Type |
Name |
Description |
| Orientation |
orientation |
The orientation of the scrollbar.
|
| int |
size |
|
| Point |
position |
The position of the scrollbar.
|
UpdateAndRedraw(TimeSpan)
Updates each control hosted by this control.
Declaration
public override void UpdateAndRedraw(TimeSpan time)
Parameters
| Type |
Name |
Description |
| TimeSpan |
time |
The game frame time delta.
|
Overrides
Events
OnCellDoubleClick
Fires an event when a cell is double clicked.
Declaration
public event EventHandler<Table.CellEventArgs>? OnCellDoubleClick
Event Type
OnCellEnter
Fires an event when a cell is entered by the mouse.
Declaration
public event EventHandler<Table.CellEventArgs>? OnCellEnter
Event Type
OnCellExit
Fires an event when a cell is exited by the mouse.
Declaration
public event EventHandler<Table.CellEventArgs>? OnCellExit
Event Type
OnCellLeftClick
Fires an event when a cell is left clicked.
Declaration
public event EventHandler<Table.CellEventArgs>? OnCellLeftClick
Event Type
OnCellRightClick
Fires an event when a cell is right clicked.
Declaration
public event EventHandler<Table.CellEventArgs>? OnCellRightClick
Event Type
OnDrawFakeCell
Called when a fake cells is being drawn, you can use this to modify the cell layout.
Declaration
public event EventHandler<Table.CellEventArgs>? OnDrawFakeCell
Event Type
SelectedCellChanged
Fires an event when the selected cell has changed.
Declaration
public event EventHandler<Table.CellChangedEventArgs>? SelectedCellChanged
Event Type
Implements
Extension Methods