Terminal.Gui.Colors.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400
  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.4.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. <link href="https://fonts.googleapis.com/css?family=Source Sans Pro" rel="stylesheet">
  18. <link href="https://fonts.googleapis.com/css?family=Source Code Pro" rel="stylesheet">
  19. <meta property="docfx:navrel" content="../../toc.html">
  20. <meta property="docfx:tocrel" content="toc.html">
  21. <meta property="docfx:rel" content="../../">
  22. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  23. <div id="wrapper">
  24. <header>
  25. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  26. <div class="container">
  27. <div class="navbar-header">
  28. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  29. <span class="sr-only">Toggle navigation</span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. </button>
  34. <a class="navbar-brand" href="../../index.html">
  35. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  36. </a>
  37. </div>
  38. <div class="collapse navbar-collapse" id="navbar">
  39. <form class="navbar-form navbar-right" role="search" id="search">
  40. <div class="form-group">
  41. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  42. </div>
  43. </form>
  44. </div>
  45. </div>
  46. </nav>
  47. <div class="subnav navbar navbar-default">
  48. <div class="container hide-when-search" id="breadcrumb">
  49. <ul class="breadcrumb">
  50. <li></li>
  51. </ul>
  52. </div>
  53. </div>
  54. </header>
  55. <div class="container body-content">
  56. <div id="search-results">
  57. <div class="search-list">Search Results for <span></span></div>
  58. <div class="sr-items">
  59. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  60. </div>
  61. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  62. </div>
  63. </div>
  64. <div role="main" class="container body-content hide-when-search">
  65. <div class="sidenav hide-when-search">
  66. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  67. <div class="sidetoggle collapse" id="sidetoggle">
  68. <div id="sidetoc"></div>
  69. </div>
  70. </div>
  71. <div class="article row grid-right">
  72. <div class="col-md-10">
  73. <article class="content wrap" id="_content" data-uid="Terminal.Gui.Colors">
  74. <h1 id="Terminal_Gui_Colors" data-uid="Terminal.Gui.Colors" class="text-break">Class Colors
  75. </h1>
  76. <div class="markdown level0 summary">
  77. The default <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a>s for the application.
  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">Colors</span></div>
  84. </div>
  85. <h5 id="Terminal_Gui_Colors_remarks"><strong>Remarks</strong></h5>
  86. <div class="markdown level0 remarks">
  87. This property can be set in a Theme to change the default <a class="xref" href="Terminal.Gui.Colors.html">Colors</a> for the application.
  88. </div>
  89. <div class="inheritedMembers">
  90. <h5>Inherited Members</h5>
  91. <div>
  92. <span class="xref">System.Object.Equals(System.Object)</span>
  93. </div>
  94. <div>
  95. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  96. </div>
  97. <div>
  98. <span class="xref">System.Object.GetHashCode()</span>
  99. </div>
  100. <div>
  101. <span class="xref">System.Object.GetType()</span>
  102. </div>
  103. <div>
  104. <span class="xref">System.Object.MemberwiseClone()</span>
  105. </div>
  106. <div>
  107. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  108. </div>
  109. <div>
  110. <span class="xref">System.Object.ToString()</span>
  111. </div>
  112. </div>
  113. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  114. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  115. <h5 id="Terminal_Gui_Colors_syntax">Syntax</h5>
  116. <div class="codewrapper">
  117. <pre><code class="lang-csharp hljs">public static class Colors</code></pre>
  118. </div>
  119. <h3 id="properties">Properties
  120. </h3>
  121. <span class="small pull-right mobile-hide">
  122. <span class="divider">|</span>
  123. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Colors_Base.md&amp;value=---%0Auid%3A%20Terminal.Gui.Colors.Base%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  124. </span>
  125. <span class="small pull-right mobile-hide">
  126. <a href="https://github.com/gui-cs/Terminal.Gui/blob/develop/Terminal.Gui/Core/ConsoleDriver.cs/#L543">View Source</a>
  127. </span>
  128. <a id="Terminal_Gui_Colors_Base_" data-uid="Terminal.Gui.Colors.Base*"></a>
  129. <h4 id="Terminal_Gui_Colors_Base" data-uid="Terminal.Gui.Colors.Base">Base</h4>
  130. <div class="markdown level1 summary">
  131. The base color scheme, for the default toplevel views.
  132. </div>
  133. <div class="markdown level1 conceptual"></div>
  134. <h5 class="decalaration">Declaration</h5>
  135. <div class="codewrapper">
  136. <pre><code class="lang-csharp hljs">public static ColorScheme Base { get; set; }</code></pre>
  137. </div>
  138. <h5 class="propertyValue">Property Value</h5>
  139. <table class="table table-bordered table-striped table-condensed">
  140. <thead>
  141. <tr>
  142. <th>Type</th>
  143. <th>Description</th>
  144. </tr>
  145. </thead>
  146. <tbody>
  147. <tr>
  148. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  149. <td></td>
  150. </tr>
  151. </tbody>
  152. </table>
  153. <span class="small pull-right mobile-hide">
  154. <span class="divider">|</span>
  155. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Colors_ColorSchemes.md&amp;value=---%0Auid%3A%20Terminal.Gui.Colors.ColorSchemes%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  156. </span>
  157. <span class="small pull-right mobile-hide">
  158. <a href="https://github.com/gui-cs/Terminal.Gui/blob/develop/Terminal.Gui/Core/ConsoleDriver.cs/#L589">View Source</a>
  159. </span>
  160. <a id="Terminal_Gui_Colors_ColorSchemes_" data-uid="Terminal.Gui.Colors.ColorSchemes*"></a>
  161. <h4 id="Terminal_Gui_Colors_ColorSchemes" data-uid="Terminal.Gui.Colors.ColorSchemes">ColorSchemes</h4>
  162. <div class="markdown level1 summary">
  163. Provides the defined <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a>s.
  164. </div>
  165. <div class="markdown level1 conceptual"></div>
  166. <h5 class="decalaration">Declaration</h5>
  167. <div class="codewrapper">
  168. <pre><code class="lang-csharp hljs">public static Dictionary&lt;string, ColorScheme&gt; ColorSchemes { get; }</code></pre>
  169. </div>
  170. <h5 class="propertyValue">Property Value</h5>
  171. <table class="table table-bordered table-striped table-condensed">
  172. <thead>
  173. <tr>
  174. <th>Type</th>
  175. <th>Description</th>
  176. </tr>
  177. </thead>
  178. <tbody>
  179. <tr>
  180. <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>
  181. <td></td>
  182. </tr>
  183. </tbody>
  184. </table>
  185. <span class="small pull-right mobile-hide">
  186. <span class="divider">|</span>
  187. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Colors_Dialog.md&amp;value=---%0Auid%3A%20Terminal.Gui.Colors.Dialog%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  188. </span>
  189. <span class="small pull-right mobile-hide">
  190. <a href="https://github.com/gui-cs/Terminal.Gui/blob/develop/Terminal.Gui/Core/ConsoleDriver.cs/#L553">View Source</a>
  191. </span>
  192. <a id="Terminal_Gui_Colors_Dialog_" data-uid="Terminal.Gui.Colors.Dialog*"></a>
  193. <h4 id="Terminal_Gui_Colors_Dialog" data-uid="Terminal.Gui.Colors.Dialog">Dialog</h4>
  194. <div class="markdown level1 summary">
  195. The dialog color scheme, for standard popup dialog boxes
  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 static ColorScheme Dialog { 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><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  213. <td></td>
  214. </tr>
  215. </tbody>
  216. </table>
  217. <span class="small pull-right mobile-hide">
  218. <span class="divider">|</span>
  219. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Colors_Error.md&amp;value=---%0Auid%3A%20Terminal.Gui.Colors.Error%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  220. </span>
  221. <span class="small pull-right mobile-hide">
  222. <a href="https://github.com/gui-cs/Terminal.Gui/blob/develop/Terminal.Gui/Core/ConsoleDriver.cs/#L573">View Source</a>
  223. </span>
  224. <a id="Terminal_Gui_Colors_Error_" data-uid="Terminal.Gui.Colors.Error*"></a>
  225. <h4 id="Terminal_Gui_Colors_Error" data-uid="Terminal.Gui.Colors.Error">Error</h4>
  226. <div class="markdown level1 summary">
  227. The color scheme for showing errors.
  228. </div>
  229. <div class="markdown level1 conceptual"></div>
  230. <h5 class="decalaration">Declaration</h5>
  231. <div class="codewrapper">
  232. <pre><code class="lang-csharp hljs">public static ColorScheme Error { get; set; }</code></pre>
  233. </div>
  234. <h5 class="propertyValue">Property Value</h5>
  235. <table class="table table-bordered table-striped table-condensed">
  236. <thead>
  237. <tr>
  238. <th>Type</th>
  239. <th>Description</th>
  240. </tr>
  241. </thead>
  242. <tbody>
  243. <tr>
  244. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  245. <td></td>
  246. </tr>
  247. </tbody>
  248. </table>
  249. <span class="small pull-right mobile-hide">
  250. <span class="divider">|</span>
  251. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Colors_Menu.md&amp;value=---%0Auid%3A%20Terminal.Gui.Colors.Menu%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  252. </span>
  253. <span class="small pull-right mobile-hide">
  254. <a href="https://github.com/gui-cs/Terminal.Gui/blob/develop/Terminal.Gui/Core/ConsoleDriver.cs/#L563">View Source</a>
  255. </span>
  256. <a id="Terminal_Gui_Colors_Menu_" data-uid="Terminal.Gui.Colors.Menu*"></a>
  257. <h4 id="Terminal_Gui_Colors_Menu" data-uid="Terminal.Gui.Colors.Menu">Menu</h4>
  258. <div class="markdown level1 summary">
  259. The menu bar color
  260. </div>
  261. <div class="markdown level1 conceptual"></div>
  262. <h5 class="decalaration">Declaration</h5>
  263. <div class="codewrapper">
  264. <pre><code class="lang-csharp hljs">public static ColorScheme Menu { get; set; }</code></pre>
  265. </div>
  266. <h5 class="propertyValue">Property Value</h5>
  267. <table class="table table-bordered table-striped table-condensed">
  268. <thead>
  269. <tr>
  270. <th>Type</th>
  271. <th>Description</th>
  272. </tr>
  273. </thead>
  274. <tbody>
  275. <tr>
  276. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  277. <td></td>
  278. </tr>
  279. </tbody>
  280. </table>
  281. <span class="small pull-right mobile-hide">
  282. <span class="divider">|</span>
  283. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Colors_TopLevel.md&amp;value=---%0Auid%3A%20Terminal.Gui.Colors.TopLevel%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  284. </span>
  285. <span class="small pull-right mobile-hide">
  286. <a href="https://github.com/gui-cs/Terminal.Gui/blob/develop/Terminal.Gui/Core/ConsoleDriver.cs/#L533">View Source</a>
  287. </span>
  288. <a id="Terminal_Gui_Colors_TopLevel_" data-uid="Terminal.Gui.Colors.TopLevel*"></a>
  289. <h4 id="Terminal_Gui_Colors_TopLevel" data-uid="Terminal.Gui.Colors.TopLevel">TopLevel</h4>
  290. <div class="markdown level1 summary">
  291. The application toplevel color scheme, for the default toplevel views.
  292. </div>
  293. <div class="markdown level1 conceptual"></div>
  294. <h5 class="decalaration">Declaration</h5>
  295. <div class="codewrapper">
  296. <pre><code class="lang-csharp hljs">public static ColorScheme TopLevel { get; set; }</code></pre>
  297. </div>
  298. <h5 class="propertyValue">Property Value</h5>
  299. <table class="table table-bordered table-striped table-condensed">
  300. <thead>
  301. <tr>
  302. <th>Type</th>
  303. <th>Description</th>
  304. </tr>
  305. </thead>
  306. <tbody>
  307. <tr>
  308. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  309. <td></td>
  310. </tr>
  311. </tbody>
  312. </table>
  313. <h3 id="methods">Methods
  314. </h3>
  315. <span class="small pull-right mobile-hide">
  316. <span class="divider">|</span>
  317. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Colors_Create.md&amp;value=---%0Auid%3A%20Terminal.Gui.Colors.Create%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  318. </span>
  319. <span class="small pull-right mobile-hide">
  320. <a href="https://github.com/gui-cs/Terminal.Gui/blob/develop/Terminal.Gui/Core/ConsoleDriver.cs/#L515">View Source</a>
  321. </span>
  322. <a id="Terminal_Gui_Colors_Create_" data-uid="Terminal.Gui.Colors.Create*"></a>
  323. <h4 id="Terminal_Gui_Colors_Create" data-uid="Terminal.Gui.Colors.Create">Create()</h4>
  324. <div class="markdown level1 summary">
  325. Creates a new dictionary of new <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a> objects.
  326. </div>
  327. <div class="markdown level1 conceptual"></div>
  328. <h5 class="decalaration">Declaration</h5>
  329. <div class="codewrapper">
  330. <pre><code class="lang-csharp hljs">public static Dictionary&lt;string, ColorScheme&gt; Create()</code></pre>
  331. </div>
  332. <h5 class="returns">Returns</h5>
  333. <table class="table table-bordered table-striped table-condensed">
  334. <thead>
  335. <tr>
  336. <th>Type</th>
  337. <th>Description</th>
  338. </tr>
  339. </thead>
  340. <tbody>
  341. <tr>
  342. <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>
  343. <td></td>
  344. </tr>
  345. </tbody>
  346. </table>
  347. </article>
  348. </div>
  349. <div class="hidden-sm col-md-2" role="complementary">
  350. <div class="sideaffix">
  351. <div class="contribution">
  352. <ul class="nav">
  353. <li>
  354. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Colors.md&amp;value=---%0Auid%3A%20Terminal.Gui.Colors%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
  355. </li>
  356. <li>
  357. <a href="https://github.com/gui-cs/Terminal.Gui/blob/develop/Terminal.Gui/Core/ConsoleDriver.cs/#L491" class="contribution-link">View Source</a>
  358. </li>
  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>