Files
Terminal.Gui/docs/api/Terminal.Gui/Terminal.Gui.TableView.TableStyle.html
Tig Kindel 26d2353e40 Prep for Release v1.7.0 (#1910)
* prepping for v1.7 release

* Updated release notes for v1.7

* updated rel notes

* regen docs

* trying to fix view source

* reactive ui update
2022-07-28 05:39:06 -07:00

562 lines
22 KiB
HTML

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class TableView.TableStyle
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class TableView.TableStyle
">
<meta name="generator" content="docfx 2.59.3.0">
<link rel="shortcut icon" href="../../favicon.ico">
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
<link rel="stylesheet" href="../../styles/docfx.css">
<link rel="stylesheet" href="../../styles/main.css">
<link href="https://fonts.googleapis.com/css?family=Source Sans Pro" rel="stylesheet">
<link href="https://fonts.googleapis.com/css?family=Source Code Pro" rel="stylesheet">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../../">
</head> <body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">
<img id="logo" class="svg" src="../../images/logo48.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list">Search Results for <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Terminal.Gui.TableView.TableStyle">
<h1 id="Terminal_Gui_TableView_TableStyle" data-uid="Terminal.Gui.TableView.TableStyle" class="text-break">Class TableView.TableStyle
</h1>
<div class="markdown level0 summary">
Defines rendering options that affect how the table is displayed.
<a href="https://gui-cs.github.io/Terminal.Gui/articles/tableview.html">See TableView Deep Dive for more information</a>.
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">TableView.TableStyle</span></div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
<h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
<h5 id="Terminal_Gui_TableView_TableStyle_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class TableStyle : Object</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<a id="Terminal_Gui_TableView_TableStyle__ctor_" data-uid="Terminal.Gui.TableView.TableStyle.#ctor*"></a>
<h4 id="Terminal_Gui_TableView_TableStyle__ctor" data-uid="Terminal.Gui.TableView.TableStyle.#ctor">TableStyle()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TableStyle()</code></pre>
</div>
<h3 id="properties">Properties
</h3>
<a id="Terminal_Gui_TableView_TableStyle_AlwaysShowHeaders_" data-uid="Terminal.Gui.TableView.TableStyle.AlwaysShowHeaders*"></a>
<h4 id="Terminal_Gui_TableView_TableStyle_AlwaysShowHeaders" data-uid="Terminal.Gui.TableView.TableStyle.AlwaysShowHeaders">AlwaysShowHeaders</h4>
<div class="markdown level1 summary">
When scrolling down always lock the column headers in place as the first row of the table
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool AlwaysShowHeaders { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_TableView_TableStyle_ColumnStyles_" data-uid="Terminal.Gui.TableView.TableStyle.ColumnStyles*"></a>
<h4 id="Terminal_Gui_TableView_TableStyle_ColumnStyles" data-uid="Terminal.Gui.TableView.TableStyle.ColumnStyles">ColumnStyles</h4>
<div class="markdown level1 summary">
Collection of columns for which you want special rendering (e.g. custom column lengths, text alignment etc)
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Dictionary&lt;DataColumn, TableView.ColumnStyle&gt; ColumnStyles { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.Dictionary</span>&lt;<span class="xref">System.Data.DataColumn</span>, <a class="xref" href="Terminal.Gui.TableView.ColumnStyle.html">TableView.ColumnStyle</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_TableView_TableStyle_ExpandLastColumn_" data-uid="Terminal.Gui.TableView.TableStyle.ExpandLastColumn*"></a>
<h4 id="Terminal_Gui_TableView_TableStyle_ExpandLastColumn" data-uid="Terminal.Gui.TableView.TableStyle.ExpandLastColumn">ExpandLastColumn</h4>
<div class="markdown level1 summary">
Determines rendering when the last column in the table is visible but it&apos;s
content or <a class="xref" href="Terminal.Gui.TableView.ColumnStyle.html#Terminal_Gui_TableView_ColumnStyle_MaxWidth">MaxWidth</a> is less than the remaining
space in the control. True (the default) will expand the column to fill
the remaining bounds of the control. False will draw a column ending line
and leave a blank column that cannot be selected in the remaining space.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool ExpandLastColumn { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_TableView_TableStyle_InvertSelectedCellFirstCharacter_" data-uid="Terminal.Gui.TableView.TableStyle.InvertSelectedCellFirstCharacter*"></a>
<h4 id="Terminal_Gui_TableView_TableStyle_InvertSelectedCellFirstCharacter" data-uid="Terminal.Gui.TableView.TableStyle.InvertSelectedCellFirstCharacter">InvertSelectedCellFirstCharacter</h4>
<div class="markdown level1 summary">
True to invert the colors of the first symbol of the selected cell in the <a class="xref" href="Terminal.Gui.TableView.html">TableView</a>.
This gives the appearance of a cursor for when the <a class="xref" href="Terminal.Gui.ConsoleDriver.html">ConsoleDriver</a> doesn&apos;t otherwise show
this
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool InvertSelectedCellFirstCharacter { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_TableView_TableStyle_RowColorGetter_" data-uid="Terminal.Gui.TableView.TableStyle.RowColorGetter*"></a>
<h4 id="Terminal_Gui_TableView_TableStyle_RowColorGetter" data-uid="Terminal.Gui.TableView.TableStyle.RowColorGetter">RowColorGetter</h4>
<div class="markdown level1 summary">
Delegate for coloring specific rows in a different color. For cell color <a class="xref" href="Terminal.Gui.TableView.ColumnStyle.html#Terminal_Gui_TableView_ColumnStyle_ColorGetter">ColorGetter</a>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TableView.RowColorGetterDelegate RowColorGetter { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.Gui.TableView.RowColorGetterDelegate.html">TableView.RowColorGetterDelegate</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_TableView_TableStyle_ShowHorizontalHeaderOverline_" data-uid="Terminal.Gui.TableView.TableStyle.ShowHorizontalHeaderOverline*"></a>
<h4 id="Terminal_Gui_TableView_TableStyle_ShowHorizontalHeaderOverline" data-uid="Terminal.Gui.TableView.TableStyle.ShowHorizontalHeaderOverline">ShowHorizontalHeaderOverline</h4>
<div class="markdown level1 summary">
True to render a solid line above the headers
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool ShowHorizontalHeaderOverline { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_TableView_TableStyle_ShowHorizontalHeaderUnderline_" data-uid="Terminal.Gui.TableView.TableStyle.ShowHorizontalHeaderUnderline*"></a>
<h4 id="Terminal_Gui_TableView_TableStyle_ShowHorizontalHeaderUnderline" data-uid="Terminal.Gui.TableView.TableStyle.ShowHorizontalHeaderUnderline">ShowHorizontalHeaderUnderline</h4>
<div class="markdown level1 summary">
True to render a solid line under the headers
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool ShowHorizontalHeaderUnderline { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_TableView_TableStyle_ShowHorizontalScrollIndicators_" data-uid="Terminal.Gui.TableView.TableStyle.ShowHorizontalScrollIndicators*"></a>
<h4 id="Terminal_Gui_TableView_TableStyle_ShowHorizontalScrollIndicators" data-uid="Terminal.Gui.TableView.TableStyle.ShowHorizontalScrollIndicators">ShowHorizontalScrollIndicators</h4>
<div class="markdown level1 summary">
True to render a arrows on the right/left of the table when
there are more column(s) that can be scrolled to. Requires
<a class="xref" href="Terminal.Gui.TableView.TableStyle.html#Terminal_Gui_TableView_TableStyle_ShowHorizontalHeaderUnderline">ShowHorizontalHeaderUnderline</a> to be true.
Defaults to true
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool ShowHorizontalScrollIndicators { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_TableView_TableStyle_ShowVerticalCellLines_" data-uid="Terminal.Gui.TableView.TableStyle.ShowVerticalCellLines*"></a>
<h4 id="Terminal_Gui_TableView_TableStyle_ShowVerticalCellLines" data-uid="Terminal.Gui.TableView.TableStyle.ShowVerticalCellLines">ShowVerticalCellLines</h4>
<div class="markdown level1 summary">
True to render a solid line vertical line between cells
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool ShowVerticalCellLines { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_TableView_TableStyle_ShowVerticalHeaderLines_" data-uid="Terminal.Gui.TableView.TableStyle.ShowVerticalHeaderLines*"></a>
<h4 id="Terminal_Gui_TableView_TableStyle_ShowVerticalHeaderLines" data-uid="Terminal.Gui.TableView.TableStyle.ShowVerticalHeaderLines">ShowVerticalHeaderLines</h4>
<div class="markdown level1 summary">
True to render a solid line vertical line between headers
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool ShowVerticalHeaderLines { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_TableView_TableStyle_SmoothHorizontalScrolling_" data-uid="Terminal.Gui.TableView.TableStyle.SmoothHorizontalScrolling*"></a>
<h4 id="Terminal_Gui_TableView_TableStyle_SmoothHorizontalScrolling" data-uid="Terminal.Gui.TableView.TableStyle.SmoothHorizontalScrolling">SmoothHorizontalScrolling</h4>
<div class="markdown level1 summary">
<p>
Determines how <a class="xref" href="Terminal.Gui.TableView.html#Terminal_Gui_TableView_ColumnOffset">ColumnOffset</a> is updated when scrolling
right off the end of the currently visible area.
</p>
<p>
If true then when scrolling right the scroll offset is increased the minimum required to show
the new column. This may be slow if you have an incredibly large number of columns in
your table and/or slow <a class="xref" href="Terminal.Gui.TableView.ColumnStyle.html#Terminal_Gui_TableView_ColumnStyle_RepresentationGetter">RepresentationGetter</a> implementations
</p>
<p>
If false then scroll offset is set to the currently selected column (i.e. PageRight).
</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool SmoothHorizontalScrolling { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<a id="Terminal_Gui_TableView_TableStyle_GetColumnStyleIfAny_" data-uid="Terminal.Gui.TableView.TableStyle.GetColumnStyleIfAny*"></a>
<h4 id="Terminal_Gui_TableView_TableStyle_GetColumnStyleIfAny_System_Data_DataColumn_" data-uid="Terminal.Gui.TableView.TableStyle.GetColumnStyleIfAny(System.Data.DataColumn)">GetColumnStyleIfAny(DataColumn)</h4>
<div class="markdown level1 summary">
Returns the entry from <a class="xref" href="Terminal.Gui.TableView.TableStyle.html#Terminal_Gui_TableView_TableStyle_ColumnStyles">ColumnStyles</a> for the given <code data-dev-comment-type="paramref" class="paramref">col</code> or null if no custom styling is defined for it
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TableView.ColumnStyle GetColumnStyleIfAny(DataColumn col)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Data.DataColumn</span></td>
<td><span class="parametername">col</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.Gui.TableView.ColumnStyle.html">TableView.ColumnStyle</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_TableView_TableStyle_GetOrCreateColumnStyle_" data-uid="Terminal.Gui.TableView.TableStyle.GetOrCreateColumnStyle*"></a>
<h4 id="Terminal_Gui_TableView_TableStyle_GetOrCreateColumnStyle_System_Data_DataColumn_" data-uid="Terminal.Gui.TableView.TableStyle.GetOrCreateColumnStyle(System.Data.DataColumn)">GetOrCreateColumnStyle(DataColumn)</h4>
<div class="markdown level1 summary">
Returns an existing <a class="xref" href="Terminal.Gui.TableView.ColumnStyle.html">TableView.ColumnStyle</a> for the given <code data-dev-comment-type="paramref" class="paramref">col</code> or creates a new one with default options
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TableView.ColumnStyle GetOrCreateColumnStyle(DataColumn col)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Data.DataColumn</span></td>
<td><span class="parametername">col</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.Gui.TableView.ColumnStyle.html">TableView.ColumnStyle</a></td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../../styles/docfx.js"></script>
<script type="text/javascript" src="../../styles/main.js"></script>
</body>
</html>