Terminal.Gui.TableStyle.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417
  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Class TableStyle
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class TableStyle
  11. ">
  12. <meta name="generator" content="docfx 2.56.7.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <meta property="docfx:navrel" content="../../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list">Search Results for <span></span></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Terminal.Gui.TableStyle">
  73. <h1 id="Terminal_Gui_TableStyle" data-uid="Terminal.Gui.TableStyle" class="text-break">Class TableStyle
  74. </h1>
  75. <div class="markdown level0 summary">
  76. Defines rendering options that affect how the table is displayed.
  77. <a href="https://migueldeicaza.github.io/gui.cs/articles/tableview.html">See TableView Deep Dive for more information</a>.
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <div class="inheritance">
  81. <h5>Inheritance</h5>
  82. <div class="level0"><span class="xref">System.Object</span></div>
  83. <div class="level1"><span class="xref">TableStyle</span></div>
  84. </div>
  85. <div class="inheritedMembers">
  86. <h5>Inherited Members</h5>
  87. <div>
  88. <span class="xref">System.Object.Equals(System.Object)</span>
  89. </div>
  90. <div>
  91. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  92. </div>
  93. <div>
  94. <span class="xref">System.Object.GetHashCode()</span>
  95. </div>
  96. <div>
  97. <span class="xref">System.Object.GetType()</span>
  98. </div>
  99. <div>
  100. <span class="xref">System.Object.MemberwiseClone()</span>
  101. </div>
  102. <div>
  103. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  104. </div>
  105. <div>
  106. <span class="xref">System.Object.ToString()</span>
  107. </div>
  108. </div>
  109. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  110. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  111. <h5 id="Terminal_Gui_TableStyle_syntax">Syntax</h5>
  112. <div class="codewrapper">
  113. <pre><code class="lang-csharp hljs">public class TableStyle</code></pre>
  114. </div>
  115. <h3 id="properties">Properties
  116. </h3>
  117. <a id="Terminal_Gui_TableStyle_AlwaysShowHeaders_" data-uid="Terminal.Gui.TableStyle.AlwaysShowHeaders*"></a>
  118. <h4 id="Terminal_Gui_TableStyle_AlwaysShowHeaders" data-uid="Terminal.Gui.TableStyle.AlwaysShowHeaders">AlwaysShowHeaders</h4>
  119. <div class="markdown level1 summary">
  120. When scrolling down always lock the column headers in place as the first row of the table
  121. </div>
  122. <div class="markdown level1 conceptual"></div>
  123. <h5 class="decalaration">Declaration</h5>
  124. <div class="codewrapper">
  125. <pre><code class="lang-csharp hljs">public bool AlwaysShowHeaders { get; set; }</code></pre>
  126. </div>
  127. <h5 class="propertyValue">Property Value</h5>
  128. <table class="table table-bordered table-striped table-condensed">
  129. <thead>
  130. <tr>
  131. <th>Type</th>
  132. <th>Description</th>
  133. </tr>
  134. </thead>
  135. <tbody>
  136. <tr>
  137. <td><span class="xref">System.Boolean</span></td>
  138. <td></td>
  139. </tr>
  140. </tbody>
  141. </table>
  142. <a id="Terminal_Gui_TableStyle_ColumnStyles_" data-uid="Terminal.Gui.TableStyle.ColumnStyles*"></a>
  143. <h4 id="Terminal_Gui_TableStyle_ColumnStyles" data-uid="Terminal.Gui.TableStyle.ColumnStyles">ColumnStyles</h4>
  144. <div class="markdown level1 summary">
  145. Collection of columns for which you want special rendering (e.g. custom column lengths, text alignment etc)
  146. </div>
  147. <div class="markdown level1 conceptual"></div>
  148. <h5 class="decalaration">Declaration</h5>
  149. <div class="codewrapper">
  150. <pre><code class="lang-csharp hljs">public Dictionary&lt;DataColumn, ColumnStyle&gt; ColumnStyles { get; set; }</code></pre>
  151. </div>
  152. <h5 class="propertyValue">Property Value</h5>
  153. <table class="table table-bordered table-striped table-condensed">
  154. <thead>
  155. <tr>
  156. <th>Type</th>
  157. <th>Description</th>
  158. </tr>
  159. </thead>
  160. <tbody>
  161. <tr>
  162. <td><span class="xref">System.Collections.Generic.Dictionary</span>&lt;<span class="xref">System.Data.DataColumn</span>, <a class="xref" href="Terminal.Gui.ColumnStyle.html">ColumnStyle</a>&gt;</td>
  163. <td></td>
  164. </tr>
  165. </tbody>
  166. </table>
  167. <a id="Terminal_Gui_TableStyle_ShowHorizontalHeaderOverline_" data-uid="Terminal.Gui.TableStyle.ShowHorizontalHeaderOverline*"></a>
  168. <h4 id="Terminal_Gui_TableStyle_ShowHorizontalHeaderOverline" data-uid="Terminal.Gui.TableStyle.ShowHorizontalHeaderOverline">ShowHorizontalHeaderOverline</h4>
  169. <div class="markdown level1 summary">
  170. True to render a solid line above the headers
  171. </div>
  172. <div class="markdown level1 conceptual"></div>
  173. <h5 class="decalaration">Declaration</h5>
  174. <div class="codewrapper">
  175. <pre><code class="lang-csharp hljs">public bool ShowHorizontalHeaderOverline { get; set; }</code></pre>
  176. </div>
  177. <h5 class="propertyValue">Property Value</h5>
  178. <table class="table table-bordered table-striped table-condensed">
  179. <thead>
  180. <tr>
  181. <th>Type</th>
  182. <th>Description</th>
  183. </tr>
  184. </thead>
  185. <tbody>
  186. <tr>
  187. <td><span class="xref">System.Boolean</span></td>
  188. <td></td>
  189. </tr>
  190. </tbody>
  191. </table>
  192. <a id="Terminal_Gui_TableStyle_ShowHorizontalHeaderUnderline_" data-uid="Terminal.Gui.TableStyle.ShowHorizontalHeaderUnderline*"></a>
  193. <h4 id="Terminal_Gui_TableStyle_ShowHorizontalHeaderUnderline" data-uid="Terminal.Gui.TableStyle.ShowHorizontalHeaderUnderline">ShowHorizontalHeaderUnderline</h4>
  194. <div class="markdown level1 summary">
  195. True to render a solid line under the headers
  196. </div>
  197. <div class="markdown level1 conceptual"></div>
  198. <h5 class="decalaration">Declaration</h5>
  199. <div class="codewrapper">
  200. <pre><code class="lang-csharp hljs">public bool ShowHorizontalHeaderUnderline { get; set; }</code></pre>
  201. </div>
  202. <h5 class="propertyValue">Property Value</h5>
  203. <table class="table table-bordered table-striped table-condensed">
  204. <thead>
  205. <tr>
  206. <th>Type</th>
  207. <th>Description</th>
  208. </tr>
  209. </thead>
  210. <tbody>
  211. <tr>
  212. <td><span class="xref">System.Boolean</span></td>
  213. <td></td>
  214. </tr>
  215. </tbody>
  216. </table>
  217. <a id="Terminal_Gui_TableStyle_ShowVerticalCellLines_" data-uid="Terminal.Gui.TableStyle.ShowVerticalCellLines*"></a>
  218. <h4 id="Terminal_Gui_TableStyle_ShowVerticalCellLines" data-uid="Terminal.Gui.TableStyle.ShowVerticalCellLines">ShowVerticalCellLines</h4>
  219. <div class="markdown level1 summary">
  220. True to render a solid line vertical line between cells
  221. </div>
  222. <div class="markdown level1 conceptual"></div>
  223. <h5 class="decalaration">Declaration</h5>
  224. <div class="codewrapper">
  225. <pre><code class="lang-csharp hljs">public bool ShowVerticalCellLines { get; set; }</code></pre>
  226. </div>
  227. <h5 class="propertyValue">Property Value</h5>
  228. <table class="table table-bordered table-striped table-condensed">
  229. <thead>
  230. <tr>
  231. <th>Type</th>
  232. <th>Description</th>
  233. </tr>
  234. </thead>
  235. <tbody>
  236. <tr>
  237. <td><span class="xref">System.Boolean</span></td>
  238. <td></td>
  239. </tr>
  240. </tbody>
  241. </table>
  242. <a id="Terminal_Gui_TableStyle_ShowVerticalHeaderLines_" data-uid="Terminal.Gui.TableStyle.ShowVerticalHeaderLines*"></a>
  243. <h4 id="Terminal_Gui_TableStyle_ShowVerticalHeaderLines" data-uid="Terminal.Gui.TableStyle.ShowVerticalHeaderLines">ShowVerticalHeaderLines</h4>
  244. <div class="markdown level1 summary">
  245. True to render a solid line vertical line between headers
  246. </div>
  247. <div class="markdown level1 conceptual"></div>
  248. <h5 class="decalaration">Declaration</h5>
  249. <div class="codewrapper">
  250. <pre><code class="lang-csharp hljs">public bool ShowVerticalHeaderLines { get; set; }</code></pre>
  251. </div>
  252. <h5 class="propertyValue">Property Value</h5>
  253. <table class="table table-bordered table-striped table-condensed">
  254. <thead>
  255. <tr>
  256. <th>Type</th>
  257. <th>Description</th>
  258. </tr>
  259. </thead>
  260. <tbody>
  261. <tr>
  262. <td><span class="xref">System.Boolean</span></td>
  263. <td></td>
  264. </tr>
  265. </tbody>
  266. </table>
  267. <h3 id="methods">Methods
  268. </h3>
  269. <a id="Terminal_Gui_TableStyle_GetColumnStyleIfAny_" data-uid="Terminal.Gui.TableStyle.GetColumnStyleIfAny*"></a>
  270. <h4 id="Terminal_Gui_TableStyle_GetColumnStyleIfAny_System_Data_DataColumn_" data-uid="Terminal.Gui.TableStyle.GetColumnStyleIfAny(System.Data.DataColumn)">GetColumnStyleIfAny(DataColumn)</h4>
  271. <div class="markdown level1 summary">
  272. Returns the entry from <a class="xref" href="Terminal.Gui.TableStyle.html#Terminal_Gui_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
  273. </div>
  274. <div class="markdown level1 conceptual"></div>
  275. <h5 class="decalaration">Declaration</h5>
  276. <div class="codewrapper">
  277. <pre><code class="lang-csharp hljs">public ColumnStyle GetColumnStyleIfAny(DataColumn col)</code></pre>
  278. </div>
  279. <h5 class="parameters">Parameters</h5>
  280. <table class="table table-bordered table-striped table-condensed">
  281. <thead>
  282. <tr>
  283. <th>Type</th>
  284. <th>Name</th>
  285. <th>Description</th>
  286. </tr>
  287. </thead>
  288. <tbody>
  289. <tr>
  290. <td><span class="xref">System.Data.DataColumn</span></td>
  291. <td><span class="parametername">col</span></td>
  292. <td></td>
  293. </tr>
  294. </tbody>
  295. </table>
  296. <h5 class="returns">Returns</h5>
  297. <table class="table table-bordered table-striped table-condensed">
  298. <thead>
  299. <tr>
  300. <th>Type</th>
  301. <th>Description</th>
  302. </tr>
  303. </thead>
  304. <tbody>
  305. <tr>
  306. <td><a class="xref" href="Terminal.Gui.ColumnStyle.html">ColumnStyle</a></td>
  307. <td></td>
  308. </tr>
  309. </tbody>
  310. </table>
  311. <a id="Terminal_Gui_TableStyle_GetOrCreateColumnStyle_" data-uid="Terminal.Gui.TableStyle.GetOrCreateColumnStyle*"></a>
  312. <h4 id="Terminal_Gui_TableStyle_GetOrCreateColumnStyle_System_Data_DataColumn_" data-uid="Terminal.Gui.TableStyle.GetOrCreateColumnStyle(System.Data.DataColumn)">GetOrCreateColumnStyle(DataColumn)</h4>
  313. <div class="markdown level1 summary">
  314. Returns an existing <a class="xref" href="Terminal.Gui.ColumnStyle.html">ColumnStyle</a> for the given <code data-dev-comment-type="paramref" class="paramref">col</code> or creates a new one with default options
  315. </div>
  316. <div class="markdown level1 conceptual"></div>
  317. <h5 class="decalaration">Declaration</h5>
  318. <div class="codewrapper">
  319. <pre><code class="lang-csharp hljs">public ColumnStyle GetOrCreateColumnStyle(DataColumn col)</code></pre>
  320. </div>
  321. <h5 class="parameters">Parameters</h5>
  322. <table class="table table-bordered table-striped table-condensed">
  323. <thead>
  324. <tr>
  325. <th>Type</th>
  326. <th>Name</th>
  327. <th>Description</th>
  328. </tr>
  329. </thead>
  330. <tbody>
  331. <tr>
  332. <td><span class="xref">System.Data.DataColumn</span></td>
  333. <td><span class="parametername">col</span></td>
  334. <td></td>
  335. </tr>
  336. </tbody>
  337. </table>
  338. <h5 class="returns">Returns</h5>
  339. <table class="table table-bordered table-striped table-condensed">
  340. <thead>
  341. <tr>
  342. <th>Type</th>
  343. <th>Description</th>
  344. </tr>
  345. </thead>
  346. <tbody>
  347. <tr>
  348. <td><a class="xref" href="Terminal.Gui.ColumnStyle.html">ColumnStyle</a></td>
  349. <td></td>
  350. </tr>
  351. </tbody>
  352. </table>
  353. </article>
  354. </div>
  355. <div class="hidden-sm col-md-2" role="complementary">
  356. <div class="sideaffix">
  357. <div class="contribution">
  358. <ul class="nav">
  359. </ul>
  360. </div>
  361. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  362. <h5>In This Article</h5>
  363. <div></div>
  364. </nav>
  365. </div>
  366. </div>
  367. </div>
  368. </div>
  369. <footer>
  370. <div class="grad-bottom"></div>
  371. <div class="footer">
  372. <div class="container">
  373. <span class="pull-right">
  374. <a href="#top">Back to top</a>
  375. </span>
  376. <span>Generated by <strong>DocFX</strong></span>
  377. </div>
  378. </div>
  379. </footer>
  380. </div>
  381. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  382. <script type="text/javascript" src="../../styles/docfx.js"></script>
  383. <script type="text/javascript" src="../../styles/main.js"></script>
  384. </body>
  385. </html>