mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-27 16:27:55 +01:00
038cf8aa45
* WIP: Add ITableDataSource * WIP: Refactor TableView * WIP: Port CSVEditor * WIP: Port TableEditor * WIP: Port MultiColouredTable scenario * Fix bug of adding duplicate column styles * Update tests to use DataTableSource * Tidy up * Add EnumerableTableDataSource<T> * Add test for EnumerableTableDataSource * Add test for EnumerableTableDataSource * Add code example to xmldoc * Add ProcessTable scenario * Rename ITableDataSource to ITableSource and update docs * Rename EnumerableTableDataSource to EnumerableTableSource * Fixed Frame != Bounds; changed UICat Scenarios list to use tableview! * Fix scroll resetting in ProcessTable scenario * Fix unit tests by setting Frame to same as Bounds * Document why we have to measure our data for use with TableView --------- Co-authored-by: Tig Kindel <tig@users.noreply.github.com>
86 lines
2.7 KiB
Markdown
86 lines
2.7 KiB
Markdown
# Table View
|
|
|
|
This control supports viewing and editing tabular data. It provides a view of a [System.DataTable](https://docs.microsoft.com/en-us/dotnet/api/system.data.datatable?view=net-5.0).
|
|
|
|
System.DataTable is a core class of .net standard and can be created very easily
|
|
|
|
[TableView API Reference](~/api/Terminal.Gui/Terminal.Gui.TableView.yml)
|
|
|
|
## Csv Example
|
|
|
|
You can create a DataTable from a CSV file by creating a new instance and adding columns and rows as you read them. For a robust solution however you might want to look into a CSV parser library that deals with escaping, multi line rows etc.
|
|
|
|
```csharp
|
|
var dt = new DataTable();
|
|
var lines = File.ReadAllLines(filename);
|
|
|
|
foreach(var h in lines[0].Split(',')){
|
|
dt.Columns.Add(h);
|
|
}
|
|
|
|
foreach(var line in lines.Skip(1)) {
|
|
dt.Rows.Add(line.Split(','));
|
|
}
|
|
```
|
|
|
|
## Database Example
|
|
|
|
All Ado.net database providers (Oracle, MySql, SqlServer etc) support reading data as DataTables for example:
|
|
|
|
```csharp
|
|
var dt = new DataTable();
|
|
|
|
using(var con = new SqlConnection("Server=myServerAddress;Database=myDataBase;Trusted_Connection=True;"))
|
|
{
|
|
con.Open();
|
|
var cmd = new SqlCommand("select * from myTable;",con);
|
|
var adapter = new SqlDataAdapter(cmd);
|
|
|
|
adapter.Fill(dt);
|
|
}
|
|
```
|
|
|
|
## Displaying the table
|
|
|
|
Once you have set up your data table set it in the view:
|
|
|
|
```csharp
|
|
tableView = new TableView () {
|
|
X = 0,
|
|
Y = 0,
|
|
Width = 50,
|
|
Height = 10,
|
|
};
|
|
|
|
tableView.Table = new DataTableSource(yourDataTable);
|
|
```
|
|
|
|
## Object data
|
|
If your data objects are not stored in a `System.Data.DataTable` then you can instead
|
|
create a table using `EnumerableTableSource<T>` or implementing your own `ITableSource`
|
|
class.
|
|
|
|
For example to render data for the currently running processes:
|
|
|
|
```csharp
|
|
tableView.Table = new EnumerableTableDataSource<Process> (Process.GetProcesses (),
|
|
new Dictionary<string, Func<Process, object>>() {
|
|
{ "ID",(p)=>p.Id},
|
|
{ "Name",(p)=>p.ProcessName},
|
|
{ "Threads",(p)=>p.Threads.Count},
|
|
{ "Virtual Memory",(p)=>p.VirtualMemorySize64},
|
|
{ "Working Memory",(p)=>p.WorkingSet64},
|
|
});
|
|
```
|
|
|
|
## Table Rendering
|
|
TableView supports any size of table. You can have thousands of columns and/or millions of rows if you want.
|
|
Horizontal and vertical scrolling can be done using the mouse or keyboard.
|
|
|
|
TableView uses `ColumnOffset` and `RowOffset` to determine the first visible cell of the `System.DataTable`.
|
|
Rendering then continues until the avaialble console space is exhausted. Updating the `ColumnOffset` and
|
|
`RowOffset` changes which part of the table is rendered (scrolls the viewport).
|
|
|
|
This approach ensures that no matter how big the table, only a small number of columns/rows need to be
|
|
evaluated for rendering.
|