Terminal.Gui.Colors.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315
  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 Colors
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Colors
  11. ">
  12. <meta name="generator" content="docfx 2.59.3.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.Colors">
  73. <h1 id="Terminal_Gui_Colors" data-uid="Terminal.Gui.Colors" class="text-break">Class Colors
  74. </h1>
  75. <div class="markdown level0 summary">
  76. The default <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a>s for the application.
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <div class="inheritance">
  80. <h5>Inheritance</h5>
  81. <div class="level0"><span class="xref">System.Object</span></div>
  82. <div class="level1"><span class="xref">Colors</span></div>
  83. </div>
  84. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  85. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  86. <h5 id="Terminal_Gui_Colors_syntax">Syntax</h5>
  87. <div class="codewrapper">
  88. <pre><code class="lang-csharp hljs">public static class Colors : Object</code></pre>
  89. </div>
  90. <h3 id="properties">Properties
  91. </h3>
  92. <a id="Terminal_Gui_Colors_Base_" data-uid="Terminal.Gui.Colors.Base*"></a>
  93. <h4 id="Terminal_Gui_Colors_Base" data-uid="Terminal.Gui.Colors.Base">Base</h4>
  94. <div class="markdown level1 summary">
  95. The base color scheme, for the default toplevel views.
  96. </div>
  97. <div class="markdown level1 conceptual"></div>
  98. <h5 class="decalaration">Declaration</h5>
  99. <div class="codewrapper">
  100. <pre><code class="lang-csharp hljs">public static ColorScheme Base { get; set; }</code></pre>
  101. </div>
  102. <h5 class="propertyValue">Property Value</h5>
  103. <table class="table table-bordered table-striped table-condensed">
  104. <thead>
  105. <tr>
  106. <th>Type</th>
  107. <th>Description</th>
  108. </tr>
  109. </thead>
  110. <tbody>
  111. <tr>
  112. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  113. <td></td>
  114. </tr>
  115. </tbody>
  116. </table>
  117. <h5 id="Terminal_Gui_Colors_Base_remarks">Remarks</h5>
  118. <div class="markdown level1 remarks">
  119. <p>
  120. This API will be deprecated in the future. Use <a class="xref" href="Terminal.Gui.Colors.html#Terminal_Gui_Colors_ColorSchemes">ColorSchemes</a> instead (e.g. <code>edit.ColorScheme = Colors.ColorSchemes[&quot;Base&quot;];</code>
  121. </p>
  122. </div>
  123. <a id="Terminal_Gui_Colors_ColorSchemes_" data-uid="Terminal.Gui.Colors.ColorSchemes*"></a>
  124. <h4 id="Terminal_Gui_Colors_ColorSchemes" data-uid="Terminal.Gui.Colors.ColorSchemes">ColorSchemes</h4>
  125. <div class="markdown level1 summary">
  126. Provides the defined <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a>s.
  127. </div>
  128. <div class="markdown level1 conceptual"></div>
  129. <h5 class="decalaration">Declaration</h5>
  130. <div class="codewrapper">
  131. <pre><code class="lang-csharp hljs">public static Dictionary&lt;string, ColorScheme&gt; ColorSchemes { get; }</code></pre>
  132. </div>
  133. <h5 class="propertyValue">Property Value</h5>
  134. <table class="table table-bordered table-striped table-condensed">
  135. <thead>
  136. <tr>
  137. <th>Type</th>
  138. <th>Description</th>
  139. </tr>
  140. </thead>
  141. <tbody>
  142. <tr>
  143. <td><span class="xref">System.Collections.Generic.Dictionary</span>&lt;<span class="xref">System.String</span>, <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a>&gt;</td>
  144. <td></td>
  145. </tr>
  146. </tbody>
  147. </table>
  148. <a id="Terminal_Gui_Colors_Dialog_" data-uid="Terminal.Gui.Colors.Dialog*"></a>
  149. <h4 id="Terminal_Gui_Colors_Dialog" data-uid="Terminal.Gui.Colors.Dialog">Dialog</h4>
  150. <div class="markdown level1 summary">
  151. The dialog color scheme, for standard popup dialog boxes
  152. </div>
  153. <div class="markdown level1 conceptual"></div>
  154. <h5 class="decalaration">Declaration</h5>
  155. <div class="codewrapper">
  156. <pre><code class="lang-csharp hljs">public static ColorScheme Dialog { get; set; }</code></pre>
  157. </div>
  158. <h5 class="propertyValue">Property Value</h5>
  159. <table class="table table-bordered table-striped table-condensed">
  160. <thead>
  161. <tr>
  162. <th>Type</th>
  163. <th>Description</th>
  164. </tr>
  165. </thead>
  166. <tbody>
  167. <tr>
  168. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  169. <td></td>
  170. </tr>
  171. </tbody>
  172. </table>
  173. <h5 id="Terminal_Gui_Colors_Dialog_remarks">Remarks</h5>
  174. <div class="markdown level1 remarks">
  175. <p>
  176. This API will be deprecated in the future. Use <a class="xref" href="Terminal.Gui.Colors.html#Terminal_Gui_Colors_ColorSchemes">ColorSchemes</a> instead (e.g. <code>edit.ColorScheme = Colors.ColorSchemes[&quot;Dialog&quot;];</code>
  177. </p>
  178. </div>
  179. <a id="Terminal_Gui_Colors_Error_" data-uid="Terminal.Gui.Colors.Error*"></a>
  180. <h4 id="Terminal_Gui_Colors_Error" data-uid="Terminal.Gui.Colors.Error">Error</h4>
  181. <div class="markdown level1 summary">
  182. The color scheme for showing errors.
  183. </div>
  184. <div class="markdown level1 conceptual"></div>
  185. <h5 class="decalaration">Declaration</h5>
  186. <div class="codewrapper">
  187. <pre><code class="lang-csharp hljs">public static ColorScheme Error { get; set; }</code></pre>
  188. </div>
  189. <h5 class="propertyValue">Property Value</h5>
  190. <table class="table table-bordered table-striped table-condensed">
  191. <thead>
  192. <tr>
  193. <th>Type</th>
  194. <th>Description</th>
  195. </tr>
  196. </thead>
  197. <tbody>
  198. <tr>
  199. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  200. <td></td>
  201. </tr>
  202. </tbody>
  203. </table>
  204. <h5 id="Terminal_Gui_Colors_Error_remarks">Remarks</h5>
  205. <div class="markdown level1 remarks">
  206. <p>
  207. This API will be deprecated in the future. Use <a class="xref" href="Terminal.Gui.Colors.html#Terminal_Gui_Colors_ColorSchemes">ColorSchemes</a> instead (e.g. <code>edit.ColorScheme = Colors.ColorSchemes[&quot;Error&quot;];</code>
  208. </p>
  209. </div>
  210. <a id="Terminal_Gui_Colors_Menu_" data-uid="Terminal.Gui.Colors.Menu*"></a>
  211. <h4 id="Terminal_Gui_Colors_Menu" data-uid="Terminal.Gui.Colors.Menu">Menu</h4>
  212. <div class="markdown level1 summary">
  213. The menu bar color
  214. </div>
  215. <div class="markdown level1 conceptual"></div>
  216. <h5 class="decalaration">Declaration</h5>
  217. <div class="codewrapper">
  218. <pre><code class="lang-csharp hljs">public static ColorScheme Menu { get; set; }</code></pre>
  219. </div>
  220. <h5 class="propertyValue">Property Value</h5>
  221. <table class="table table-bordered table-striped table-condensed">
  222. <thead>
  223. <tr>
  224. <th>Type</th>
  225. <th>Description</th>
  226. </tr>
  227. </thead>
  228. <tbody>
  229. <tr>
  230. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  231. <td></td>
  232. </tr>
  233. </tbody>
  234. </table>
  235. <h5 id="Terminal_Gui_Colors_Menu_remarks">Remarks</h5>
  236. <div class="markdown level1 remarks">
  237. <p>
  238. This API will be deprecated in the future. Use <a class="xref" href="Terminal.Gui.Colors.html#Terminal_Gui_Colors_ColorSchemes">ColorSchemes</a> instead (e.g. <code>edit.ColorScheme = Colors.ColorSchemes[&quot;Menu&quot;];</code>
  239. </p>
  240. </div>
  241. <a id="Terminal_Gui_Colors_TopLevel_" data-uid="Terminal.Gui.Colors.TopLevel*"></a>
  242. <h4 id="Terminal_Gui_Colors_TopLevel" data-uid="Terminal.Gui.Colors.TopLevel">TopLevel</h4>
  243. <div class="markdown level1 summary">
  244. The application toplevel color scheme, for the default toplevel views.
  245. </div>
  246. <div class="markdown level1 conceptual"></div>
  247. <h5 class="decalaration">Declaration</h5>
  248. <div class="codewrapper">
  249. <pre><code class="lang-csharp hljs">public static ColorScheme TopLevel { get; set; }</code></pre>
  250. </div>
  251. <h5 class="propertyValue">Property Value</h5>
  252. <table class="table table-bordered table-striped table-condensed">
  253. <thead>
  254. <tr>
  255. <th>Type</th>
  256. <th>Description</th>
  257. </tr>
  258. </thead>
  259. <tbody>
  260. <tr>
  261. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  262. <td></td>
  263. </tr>
  264. </tbody>
  265. </table>
  266. <h5 id="Terminal_Gui_Colors_TopLevel_remarks">Remarks</h5>
  267. <div class="markdown level1 remarks">
  268. <p>
  269. This API will be deprecated in the future. Use <a class="xref" href="Terminal.Gui.Colors.html#Terminal_Gui_Colors_ColorSchemes">ColorSchemes</a> instead (e.g. <code>edit.ColorScheme = Colors.ColorSchemes[&quot;TopLevel&quot;];</code>
  270. </p>
  271. </div>
  272. </article>
  273. </div>
  274. <div class="hidden-sm col-md-2" role="complementary">
  275. <div class="sideaffix">
  276. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  277. <h5>In This Article</h5>
  278. <div></div>
  279. </nav>
  280. </div>
  281. </div>
  282. </div>
  283. </div>
  284. <footer>
  285. <div class="grad-bottom"></div>
  286. <div class="footer">
  287. <div class="container">
  288. <span class="pull-right">
  289. <a href="#top">Back to top</a>
  290. </span>
  291. <span>Generated by <strong>DocFX</strong></span>
  292. </div>
  293. </div>
  294. </footer>
  295. </div>
  296. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  297. <script type="text/javascript" src="../../styles/docfx.js"></script>
  298. <script type="text/javascript" src="../../styles/main.js"></script>
  299. </body>
  300. </html>