Terminal.Gui.Application.RunState.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291
  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 Application.RunState
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Application.RunState
  11. ">
  12. <link rel="shortcut icon" href="../../favicon.ico">
  13. <link rel="stylesheet" href="../../styles/docfx.vendor.min.css">
  14. <link rel="stylesheet" href="../../styles/docfx.css">
  15. <link rel="stylesheet" href="../../styles/main.css">
  16. <meta property="docfx:navrel" content="../../toc.html">
  17. <meta property="docfx:tocrel" content="toc.html">
  18. <meta property="docfx:rel" content="../../">
  19. </head>
  20. <body data-spy="scroll" data-target="#affix" data-offset="120">
  21. <div id="wrapper">
  22. <header>
  23. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  24. <div class="container">
  25. <div class="navbar-header">
  26. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  27. <span class="sr-only">Toggle navigation</span>
  28. <span class="icon-bar"></span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. </button>
  32. <a class="navbar-brand" href="../../index.html">
  33. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  34. </a>
  35. </div>
  36. <div class="collapse navbar-collapse" id="navbar">
  37. <form class="navbar-form navbar-right" role="search" id="search">
  38. <div class="form-group">
  39. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  40. </div>
  41. </form>
  42. </div>
  43. </div>
  44. </nav>
  45. <div class="subnav navbar navbar-default">
  46. <div class="container hide-when-search" id="breadcrumb">
  47. <ul class="breadcrumb">
  48. <li></li>
  49. </ul>
  50. </div>
  51. </div>
  52. </header>
  53. <div class="container body-content">
  54. <div id="search-results">
  55. <div class="search-list">Search Results for <span></span></div>
  56. <div class="sr-items">
  57. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  58. </div>
  59. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  60. </div>
  61. </div>
  62. <div role="main" class="container body-content hide-when-search">
  63. <div class="sidenav hide-when-search">
  64. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  65. <div class="sidetoggle collapse" id="sidetoggle">
  66. <div id="sidetoc"></div>
  67. </div>
  68. </div>
  69. <div class="article row grid-right">
  70. <div class="col-md-10">
  71. <article class="content wrap" id="_content" data-uid="Terminal.Gui.Application.RunState">
  72. <h1 id="Terminal_Gui_Application_RunState" data-uid="Terminal.Gui.Application.RunState" class="text-break">Class Application.RunState
  73. </h1>
  74. <div class="markdown level0 summary">Captures the execution state for the provided <a class="xref" href="Terminal.Gui.Application.RunState.html#Terminal_Gui_Application_RunState_Toplevel">Toplevel</a> view.</div>
  75. <div class="markdown level0 conceptual"></div>
  76. <div class="inheritance">
  77. <h5>Inheritance</h5>
  78. <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
  79. <div class="level1"><span class="xref">Application.RunState</span></div>
  80. </div>
  81. <div class="implements">
  82. <h5>Implements</h5>
  83. <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
  84. </div>
  85. <div class="inheritedMembers">
  86. <h5>Inherited Members</h5>
  87. <div>
  88. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
  89. </div>
  90. <div>
  91. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
  92. </div>
  93. <div>
  94. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
  95. </div>
  96. <div>
  97. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
  98. </div>
  99. <div>
  100. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
  101. </div>
  102. <div>
  103. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
  104. </div>
  105. <div>
  106. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
  107. </div>
  108. </div>
  109. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.html">Terminal</a>.<a class="xref" href="Terminal.Gui.html">Gui</a></h6>
  110. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  111. <h5 id="Terminal_Gui_Application_RunState_syntax">Syntax</h5>
  112. <div class="codewrapper">
  113. <pre><code class="lang-csharp hljs">public class Application.RunState : IDisposable</code></pre>
  114. </div>
  115. <h3 id="constructors">Constructors
  116. </h3>
  117. <span class="small pull-right mobile-hide">
  118. <span class="divider">|</span>
  119. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Application_RunState__ctor_Terminal_Gui_Toplevel_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Application.RunState.%23ctor(Terminal.Gui.Toplevel)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  120. </span>
  121. <span class="small pull-right mobile-hide">
  122. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Application.cs/#L460">View Source</a>
  123. </span>
  124. <a id="Terminal_Gui_Application_RunState__ctor_" data-uid="Terminal.Gui.Application.RunState.#ctor*"></a>
  125. <h4 id="Terminal_Gui_Application_RunState__ctor_Terminal_Gui_Toplevel_" data-uid="Terminal.Gui.Application.RunState.#ctor(Terminal.Gui.Toplevel)">RunState(Toplevel)</h4>
  126. <div class="markdown level1 summary">Initializes a new <a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a> class.</div>
  127. <div class="markdown level1 conceptual"></div>
  128. <h5 class="declaration">Declaration</h5>
  129. <div class="codewrapper">
  130. <pre><code class="lang-csharp hljs">public RunState(Toplevel view)</code></pre>
  131. </div>
  132. <h5 class="parameters">Parameters</h5>
  133. <table class="table table-bordered table-condensed">
  134. <thead>
  135. <tr>
  136. <th>Type</th>
  137. <th>Name</th>
  138. <th>Description</th>
  139. </tr>
  140. </thead>
  141. <tbody>
  142. <tr>
  143. <td><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></td>
  144. <td><span class="parametername">view</span></td>
  145. <td></td>
  146. </tr>
  147. </tbody>
  148. </table>
  149. <h3 id="properties">Properties
  150. </h3>
  151. <span class="small pull-right mobile-hide">
  152. <span class="divider">|</span>
  153. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Application_RunState_Toplevel.md&amp;value=---%0Auid%3A%20Terminal.Gui.Application.RunState.Toplevel%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  154. </span>
  155. <span class="small pull-right mobile-hide">
  156. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Application.cs/#L467">View Source</a>
  157. </span>
  158. <a id="Terminal_Gui_Application_RunState_Toplevel_" data-uid="Terminal.Gui.Application.RunState.Toplevel*"></a>
  159. <h4 id="Terminal_Gui_Application_RunState_Toplevel" data-uid="Terminal.Gui.Application.RunState.Toplevel">Toplevel</h4>
  160. <div class="markdown level1 summary">The <a class="xref" href="Terminal.Gui.Application.RunState.html#Terminal_Gui_Application_RunState_Toplevel">Toplevel</a> belong to this <a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a>.</div>
  161. <div class="markdown level1 conceptual"></div>
  162. <h5 class="declaration">Declaration</h5>
  163. <div class="codewrapper">
  164. <pre><code class="lang-csharp hljs">public Toplevel Toplevel { get; }</code></pre>
  165. </div>
  166. <h5 class="propertyValue">Property Value</h5>
  167. <table class="table table-bordered table-condensed">
  168. <thead>
  169. <tr>
  170. <th>Type</th>
  171. <th>Description</th>
  172. </tr>
  173. </thead>
  174. <tbody>
  175. <tr>
  176. <td><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></td>
  177. <td></td>
  178. </tr>
  179. </tbody>
  180. </table>
  181. <h3 id="methods">Methods
  182. </h3>
  183. <span class="small pull-right mobile-hide">
  184. <span class="divider">|</span>
  185. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Application_RunState_Dispose.md&amp;value=---%0Auid%3A%20Terminal.Gui.Application.RunState.Dispose%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  186. </span>
  187. <span class="small pull-right mobile-hide">
  188. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Application.cs/#L503">View Source</a>
  189. </span>
  190. <a id="Terminal_Gui_Application_RunState_Dispose_" data-uid="Terminal.Gui.Application.RunState.Dispose*"></a>
  191. <h4 id="Terminal_Gui_Application_RunState_Dispose" data-uid="Terminal.Gui.Application.RunState.Dispose">Dispose()</h4>
  192. <div class="markdown level1 summary">Releases all resource used by the <a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a> object.</div>
  193. <div class="markdown level1 conceptual"></div>
  194. <h5 class="declaration">Declaration</h5>
  195. <div class="codewrapper">
  196. <pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
  197. </div>
  198. <h5 id="Terminal_Gui_Application_RunState_Dispose_remarks">Remarks</h5>
  199. <div class="markdown level1 remarks">Call <a class="xref" href="Terminal.Gui.Application.RunState.html#Terminal_Gui_Application_RunState_Dispose">Dispose()</a> when you are finished using the <a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a>.</div>
  200. <span class="small pull-right mobile-hide">
  201. <span class="divider">|</span>
  202. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Application_RunState_Dispose_System_Boolean_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Application.RunState.Dispose(System.Boolean)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  203. </span>
  204. <span class="small pull-right mobile-hide">
  205. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Application.cs/#L516">View Source</a>
  206. </span>
  207. <a id="Terminal_Gui_Application_RunState_Dispose_" data-uid="Terminal.Gui.Application.RunState.Dispose*"></a>
  208. <h4 id="Terminal_Gui_Application_RunState_Dispose_System_Boolean_" data-uid="Terminal.Gui.Application.RunState.Dispose(System.Boolean)">Dispose(bool)</h4>
  209. <div class="markdown level1 summary">Releases all resource used by the <a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a> object.</div>
  210. <div class="markdown level1 conceptual"></div>
  211. <h5 class="declaration">Declaration</h5>
  212. <div class="codewrapper">
  213. <pre><code class="lang-csharp hljs">protected virtual void Dispose(bool disposing)</code></pre>
  214. </div>
  215. <h5 class="parameters">Parameters</h5>
  216. <table class="table table-bordered table-condensed">
  217. <thead>
  218. <tr>
  219. <th>Type</th>
  220. <th>Name</th>
  221. <th>Description</th>
  222. </tr>
  223. </thead>
  224. <tbody>
  225. <tr>
  226. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  227. <td><span class="parametername">disposing</span></td>
  228. <td>If set to <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> we are disposing and should dispose held objects.</td>
  229. </tr>
  230. </tbody>
  231. </table>
  232. <h3 id="implements">Implements</h3>
  233. <div>
  234. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a>
  235. </div>
  236. </article>
  237. </div>
  238. <div class="hidden-sm col-md-2" role="complementary">
  239. <div class="sideaffix">
  240. <div class="contribution">
  241. <ul class="nav">
  242. <li>
  243. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Application_RunState.md&amp;value=---%0Auid%3A%20Terminal.Gui.Application.RunState%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Edit this page</a>
  244. </li>
  245. <li>
  246. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Application.cs/#L455" class="contribution-link">View Source</a>
  247. </li>
  248. </ul>
  249. </div>
  250. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  251. <h5>In this article</h5>
  252. <div></div>
  253. </nav>
  254. </div>
  255. </div>
  256. </div>
  257. </div>
  258. <footer>
  259. <div class="grad-bottom"></div>
  260. <div class="footer">
  261. <div class="container">
  262. <span class="pull-right">
  263. <a href="#top">Back to top</a>
  264. </span>
  265. <span>Generated by <strong>DocFX</strong></span>
  266. </div>
  267. </div>
  268. </footer>
  269. </div>
  270. <script type="text/javascript" src="../../styles/docfx.vendor.min.js"></script>
  271. <script type="text/javascript" src="../../styles/docfx.js"></script>
  272. <script type="text/javascript" src="../../styles/main.js"></script>
  273. </body>
  274. </html>