Startseite Erkunden Hilfe
Anmelden
csharp
/
gui-cs.Terminal.Gui
Mirror von https://github.com/gui-cs/Terminal.Gui.git
2
0
Fork 0
Dateien Issues 0 Wiki
Struktur: 615bf80657
Branches Tags
gui-cs.Terminal...
/
docs
/
api
/
UICatalog
/
UICatalog.Scenario.html

UICatalog.Scenario.html 28 KB
Verlauf Originalformat

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543 
  1. <!DOCTYPE html>
    2. 

  2. <!--[if IE]><![endif]-->
    3. 

  3. <html>
    4. 

  4.   
    5. 

  5.   <head>
    6. 

  6.     <meta charset="utf-8">
    7. 

  7.     <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    8. 

  8.     <title>Class Scenario
    9. 

  9.    </title>
    10. 

  10.     <meta name="viewport" content="width=device-width">
    11. 

  11.     <meta name="title" content="Class Scenario
    12. 

  12.    ">
    13. 

  13.     <meta name="generator" content="docfx 2.59.0.0">
    14. 

  14.     
    15. 

  15.     <link rel="shortcut icon" href="../../favicon.ico">
    16. 

  16.     <link rel="stylesheet" href="../../styles/docfx.vendor.css">
    17. 

  17.     <link rel="stylesheet" href="../../styles/docfx.css">
    18. 

  18.     <link rel="stylesheet" href="../../styles/main.css">
    19. 

  19.     <meta property="docfx:navrel" content="../../toc.html">
    20. 

  20.     <meta property="docfx:tocrel" content="toc.html">
    21. 

  21.     
    22. 

  22.     <meta property="docfx:rel" content="../../">
    23. 

  23.     
    24. 

  24.   </head>
    25. 

  25.   <body data-spy="scroll" data-target="#affix" data-offset="120">
    26. 

  26.     <div id="wrapper">
    27. 

  27.       <header>
    28. 

  28.         
    29. 

  29.         <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
    30. 

  30.           <div class="container">
    31. 

  31.             <div class="navbar-header">
    32. 

  32.               <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
    33. 

  33.                 <span class="sr-only">Toggle navigation</span>
    34. 

  34.                 <span class="icon-bar"></span>
    35. 

  35.                 <span class="icon-bar"></span>
    36. 

  36.                 <span class="icon-bar"></span>
    37. 

  37.               </button>
    38. 

  38.               
    39. 

  39.               <a class="navbar-brand" href="../../index.html">
    40. 

  40.                 <img id="logo" class="svg" src="../../images/logo48.png" alt="">
    41. 

  41.               </a>
    42. 

  42.             </div>
    43. 

  43.             <div class="collapse navbar-collapse" id="navbar">
    44. 

  44.               <form class="navbar-form navbar-right" role="search" id="search">
    45. 

  45.                 <div class="form-group">
    46. 

  46.                   <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
    47. 

  47.                 </div>
    48. 

  48.               </form>
    49. 

  49.             </div>
    50. 

  50.           </div>
    51. 

  51.         </nav>
    52. 

  52.         
    53. 

  53.         <div class="subnav navbar navbar-default">
    54. 

  54.           <div class="container hide-when-search" id="breadcrumb">
    55. 

  55.             <ul class="breadcrumb">
    56. 

  56.               <li></li>
    57. 

  57.             </ul>
    58. 

  58.           </div>
    59. 

  59.         </div>
    60. 

  60.       </header>
    61. 

  61.       <div class="container body-content">
    62. 

  62.         
    63. 

  63.         <div id="search-results">
    64. 

  64.           <div class="search-list">Search Results for <span></span></div>
    65. 

  65.           <div class="sr-items">
    66. 

  66.             <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
    67. 

  67.           </div>
    68. 

  68.           <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
    69. 

  69.         </div>
    70. 

  70.       </div>
    71. 

  71.       <div role="main" class="container body-content hide-when-search">
    72. 

  72.         
    73. 

  73.         <div class="sidenav hide-when-search">
    74. 

  74.           <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
    75. 

  75.           <div class="sidetoggle collapse" id="sidetoggle">
    76. 

  76.             <div id="sidetoc"></div>
    77. 

  77.           </div>
    78. 

  78.         </div>
    79. 

  79.         <div class="article row grid-right">
    80. 

  80.           <div class="col-md-10">
    81. 

  81.             <article class="content wrap" id="_content" data-uid="UICatalog.Scenario">
    82. 

  82.   
    83. 

  83.   
    84. 

  84.   <h1 id="UICatalog_Scenario" data-uid="UICatalog.Scenario" class="text-break">Class Scenario
    85. 

  85.   </h1>
    86. 

  86.   <div class="markdown level0 summary"><p>Base class for each demo/scenario.</p>
    87. 

  87. <p>
    88. 

  88.  To define a new scenario:
    89. 

  89. <ol><li>Create a new <code>.cs</code> file in the <cs>Scenarios</cs> directory that derives from <a class="xref" href="UICatalog.Scenario.html">Scenario</a>.</li><li>Annotate the <a class="xref" href="UICatalog.Scenario.html">Scenario</a> derived class with a <a class="xref" href="UICatalog.Scenario.ScenarioMetadata.html">Scenario.ScenarioMetadata</a> attribute specifying the scenario&apos;s name and description.</li><li>Add one or more <a class="xref" href="UICatalog.Scenario.ScenarioCategory.html">Scenario.ScenarioCategory</a> attributes to the class specifying which categories the scenario belongs to. If you don&apos;t specify a category the scenario will show up in &quot;_All&quot;.</li><li>Implement the <a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Setup">Setup()</a> override which will be called when a user selects the scenario to run.</li><li>Optionally, implement the <a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Init_Terminal_Gui_Toplevel_Terminal_Gui_ColorScheme_">Init(Toplevel, ColorScheme)</a> and/or <a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Run">Run()</a> overrides to provide a custom implementation.</li></ol>
    90. 

  90. </p>
    91. 

  91. <p>
    92. 

  92. The UI Catalog program uses reflection to find all scenarios and adds them to the
    93. 

  93. ListViews. Press ENTER to run the selected scenario. Press CTRL-Q to exit it.   /
    94. 

  94. </p>
    95. 

  95. </div>
    96. 

  96.   <div class="markdown level0 conceptual"></div>
    97. 

  97.   <div class="inheritance">
    98. 

  98.     <h5>Inheritance</h5>
    99. 

  99.     <div class="level0"><span class="xref">System.Object</span></div>
    100. 

  100.     <div class="level1"><span class="xref">Scenario</span></div>
    101. 

  101.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.AllViewsTester.html">AllViewsTester</a></div>
    102. 

  102.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.AutoSizeAndDirectionText.html">AutoSizeAndDirectionText</a></div>
    103. 

  103.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.BackgroundWorkerCollection.html">BackgroundWorkerCollection</a></div>
    104. 

  104.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.BasicColors.html">BasicColors</a></div>
    105. 

  105.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.Borders.html">Borders</a></div>
    106. 

  106.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.BordersComparisons.html">BordersComparisons</a></div>
    107. 

  107.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.BordersOnFrameView.html">BordersOnFrameView</a></div>
    108. 

  108.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.BordersOnToplevel.html">BordersOnToplevel</a></div>
    109. 

  109.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.BordersOnWindow.html">BordersOnWindow</a></div>
    110. 

  110.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.Buttons.html">Buttons</a></div>
    111. 

  111.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.CharacterMap.html">CharacterMap</a></div>
    112. 

  112.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.ClassExplorer.html">ClassExplorer</a></div>
    113. 

  113.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.Clipping.html">Clipping</a></div>
    114. 

  114.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.ComboBoxIteration.html">ComboBoxIteration</a></div>
    115. 

  115.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.ComputedLayout.html">ComputedLayout</a></div>
    116. 

  116.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.ContextMenus.html">ContextMenus</a></div>
    117. 

  117.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.CsvEditor.html">CsvEditor</a></div>
    118. 

  118.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.Dialogs.html">Dialogs</a></div>
    119. 

  119.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.DynamicMenuBar.html">DynamicMenuBar</a></div>
    120. 

  120.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.DynamicStatusBar.html">DynamicStatusBar</a></div>
    121. 

  121.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.Editor.html">Editor</a></div>
    122. 

  122.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.GraphViewExample.html">GraphViewExample</a></div>
    123. 

  123.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.HexEditor.html">HexEditor</a></div>
    124. 

  124.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.InteractiveTree.html">InteractiveTree</a></div>
    125. 

  125.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.InvertColors.html">InvertColors</a></div>
    126. 

  126.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.Keys.html">Keys</a></div>
    127. 

  127.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.LabelsAsLabels.html">LabelsAsLabels</a></div>
    128. 

  128.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.LineViewExample.html">LineViewExample</a></div>
    129. 

  129.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.ListsAndCombos.html">ListsAndCombos</a></div>
    130. 

  130.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.ListViewWithSelection.html">ListViewWithSelection</a></div>
    131. 

  131.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.MessageBoxes.html">MessageBoxes</a></div>
    132. 

  132.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.Mouse.html">Mouse</a></div>
    133. 

  133.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.MultiColouredTable.html">MultiColouredTable</a></div>
    134. 

  134.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.MyScenario.html">MyScenario</a></div>
    135. 

  135.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.Notepad.html">Notepad</a></div>
    136. 

  136.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.Progress.html">Progress</a></div>
    137. 

  137.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.ProgressBarStyles.html">ProgressBarStyles</a></div>
    138. 

  138.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.Scrolling.html">Scrolling</a></div>
    139. 

  139.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.SendKeys.html">SendKeys</a></div>
    140. 

  140.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.SingleBackgroundWorker.html">SingleBackgroundWorker</a></div>
    141. 

  141.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.SyntaxHighlighting.html">SyntaxHighlighting</a></div>
    142. 

  142.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.TableEditor.html">TableEditor</a></div>
    143. 

  143.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.TabViewExample.html">TabViewExample</a></div>
    144. 

  144.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.Text.html">Text</a></div>
    145. 

  145.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.TextAlignments.html">TextAlignments</a></div>
    146. 

  146.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.TextAlignmentsAndDirections.html">TextAlignmentsAndDirections</a></div>
    147. 

  147.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.TextFormatterDemo.html">TextFormatterDemo</a></div>
    148. 

  148.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.TextViewAutocompletePopup.html">TextViewAutocompletePopup</a></div>
    149. 

  149.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.Threading.html">Threading</a></div>
    150. 

  150.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.TimeAndDate.html">TimeAndDate</a></div>
    151. 

  151.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.TreeUseCases.html">TreeUseCases</a></div>
    152. 

  152.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.TreeViewFileSystem.html">TreeViewFileSystem</a></div>
    153. 

  153.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.UnicodeInMenu.html">UnicodeInMenu</a></div>
    154. 

  154.       <div class="level2"><a class="xref" href="UICatalog.Scenarios.WindowsAndFrameViews.html">WindowsAndFrameViews</a></div>
    155. 

  155.   </div>
    156. 

  156.   <div classs="implements">
    157. 

  157.     <h5>Implements</h5>
    158. 

  158.     <div><span class="xref">System.IDisposable</span></div>
    159. 

  159.   </div>
    160. 

  160.   <div class="inheritedMembers">
    161. 

  161.     <h5>Inherited Members</h5>
    162. 

  162.     <div>
    163. 

  163.       <span class="xref">System.Object.Equals(System.Object)</span>
    164. 

  164.     </div>
    165. 

  165.     <div>
    166. 

  166.       <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
    167. 

  167.     </div>
    168. 

  168.     <div>
    169. 

  169.       <span class="xref">System.Object.GetHashCode()</span>
    170. 

  170.     </div>
    171. 

  171.     <div>
    172. 

  172.       <span class="xref">System.Object.GetType()</span>
    173. 

  173.     </div>
    174. 

  174.     <div>
    175. 

  175.       <span class="xref">System.Object.MemberwiseClone()</span>
    176. 

  176.     </div>
    177. 

  177.     <div>
    178. 

  178.       <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
    179. 

  179.     </div>
    180. 

  180.   </div>
    181. 

  181.   <h6><strong>Namespace</strong>: <a class="xref" href="UICatalog.html">UICatalog</a></h6>
    182. 

  182.   <h6><strong>Assembly</strong>: UICatalog.dll</h6>
    183. 

  183.   <h5 id="UICatalog_Scenario_syntax">Syntax</h5>
    184. 

  184.   <div class="codewrapper">
    185. 

  185.     <pre><code class="lang-csharp hljs">public class Scenario : IDisposable</code></pre>
    186. 

  186.   </div>
    187. 

  187.   <h5 id="UICatalog_Scenario_examples"><strong>Examples</strong></h5>
    188. 

  188.   <p>The example below is provided in the <code>Scenarios</code> directory as a generic sample that can be copied and re-named:</p>
    189. 

  189. <pre><code>using Terminal.Gui;
    190. 

  190. 

  191. namespace UICatalog {
    192. 

  192.     [ScenarioMetadata (Name: &quot;Generic&quot;, Description: &quot;Generic sample - A template for creating new Scenarios&quot;)]
    193. 

  193.     [ScenarioCategory (&quot;Controls&quot;)]
    194. 

  194.     class MyScenario : Scenario {
    195. 

  195.         public override void Setup ()
    196. 

  196.         {
    197. 

  197.             // Put your scenario code here, e.g.
    198. 

  198.             Win.Add (new Button (&quot;Press me!&quot;) {
    199. 

  199.                 X = Pos.Center (),
    200. 

  200.                 Y = Pos.Center (),
    201. 

  201.                 Clicked = () => MessageBox.Query (20, 7, &quot;Hi&quot;, &quot;Neat?&quot;, &quot;Yes&quot;, &quot;No&quot;)
    202. 

  202.             });
    203. 

  203.         }
    204. 

  204.     }
    205. 

  205. }</code></pre>
    206. 

  206. 

  207.   <h3 id="properties">Properties
    208. 

  208.   </h3>
    209. 

  209.   <a id="UICatalog_Scenario_Top_" data-uid="UICatalog.Scenario.Top*"></a>
    210. 

  210.   <h4 id="UICatalog_Scenario_Top" data-uid="UICatalog.Scenario.Top">Top</h4>
    211. 

  211.   <div class="markdown level1 summary"><p>The Top level for the <a class="xref" href="UICatalog.Scenario.html">Scenario</a>. This should be set to <a class="xref" href="../Terminal.Gui/Terminal.Gui.Application.html#Terminal_Gui_Application_Top">Top</a> in most cases.</p>
    212. 

  212. </div>
    213. 

  213.   <div class="markdown level1 conceptual"></div>
    214. 

  214.   <h5 class="decalaration">Declaration</h5>
    215. 

  215.   <div class="codewrapper">
    216. 

  216.     <pre><code class="lang-csharp hljs">public Toplevel Top { get; set; }</code></pre>
    217. 

  217.   </div>
    218. 

  218.   <h5 class="propertyValue">Property Value</h5>
    219. 

  219.   <table class="table table-bordered table-striped table-condensed">
    220. 

  220.     <thead>
    221. 

  221.       <tr>
    222. 

  222.         <th>Type</th>
    223. 

  223.         <th>Description</th>
    224. 

  224.       </tr>
    225. 

  225.     </thead>
    226. 

  226.     <tbody>
    227. 

  227.       <tr>
    228. 

  228.         <td><a class="xref" href="../Terminal.Gui/Terminal.Gui.Toplevel.html">Toplevel</a></td>
    229. 

  229.         <td></td>
    230. 

  230.       </tr>
    231. 

  231.     </tbody>
    232. 

  232.   </table>
    233. 

  233.   <a id="UICatalog_Scenario_Win_" data-uid="UICatalog.Scenario.Win*"></a>
    234. 

  234.   <h4 id="UICatalog_Scenario_Win" data-uid="UICatalog.Scenario.Win">Win</h4>
    235. 

  235.   <div class="markdown level1 summary"><p>The Window for the <a class="xref" href="UICatalog.Scenario.html">Scenario</a>. This should be set within the <a class="xref" href="../Terminal.Gui/Terminal.Gui.Application.html#Terminal_Gui_Application_Top">Top</a> in most cases.</p>
    236. 

  236. </div>
    237. 

  237.   <div class="markdown level1 conceptual"></div>
    238. 

  238.   <h5 class="decalaration">Declaration</h5>
    239. 

  239.   <div class="codewrapper">
    240. 

  240.     <pre><code class="lang-csharp hljs">public Window Win { get; set; }</code></pre>
    241. 

  241.   </div>
    242. 

  242.   <h5 class="propertyValue">Property Value</h5>
    243. 

  243.   <table class="table table-bordered table-striped table-condensed">
    244. 

  244.     <thead>
    245. 

  245.       <tr>
    246. 

  246.         <th>Type</th>
    247. 

  247.         <th>Description</th>
    248. 

  248.       </tr>
    249. 

  249.     </thead>
    250. 

  250.     <tbody>
    251. 

  251.       <tr>
    252. 

  252.         <td><a class="xref" href="../Terminal.Gui/Terminal.Gui.Window.html">Window</a></td>
    253. 

  253.         <td></td>
    254. 

  254.       </tr>
    255. 

  255.     </tbody>
    256. 

  256.   </table>
    257. 

  257.   <h3 id="methods">Methods
    258. 

  258.   </h3>
    259. 

  259.   <a id="UICatalog_Scenario_Dispose_" data-uid="UICatalog.Scenario.Dispose*"></a>
    260. 

  260.   <h4 id="UICatalog_Scenario_Dispose" data-uid="UICatalog.Scenario.Dispose">Dispose()</h4>
    261. 

  261.   <div class="markdown level1 summary"></div>
    262. 

  262.   <div class="markdown level1 conceptual"></div>
    263. 

  263.   <h5 class="decalaration">Declaration</h5>
    264. 

  264.   <div class="codewrapper">
    265. 

  265.     <pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
    266. 

  266.   </div>
    267. 

  267.   <a id="UICatalog_Scenario_Dispose_" data-uid="UICatalog.Scenario.Dispose*"></a>
    268. 

  268.   <h4 id="UICatalog_Scenario_Dispose_System_Boolean_" data-uid="UICatalog.Scenario.Dispose(System.Boolean)">Dispose(Boolean)</h4>
    269. 

  269.   <div class="markdown level1 summary"></div>
    270. 

  270.   <div class="markdown level1 conceptual"></div>
    271. 

  271.   <h5 class="decalaration">Declaration</h5>
    272. 

  272.   <div class="codewrapper">
    273. 

  273.     <pre><code class="lang-csharp hljs">protected virtual void Dispose(bool disposing)</code></pre>
    274. 

  274.   </div>
    275. 

  275.   <h5 class="parameters">Parameters</h5>
    276. 

  276.   <table class="table table-bordered table-striped table-condensed">
    277. 

  277.     <thead>
    278. 

  278.       <tr>
    279. 

  279.         <th>Type</th>
    280. 

  280.         <th>Name</th>
    281. 

  281.         <th>Description</th>
    282. 

  282.       </tr>
    283. 

  283.     </thead>
    284. 

  284.     <tbody>
    285. 

  285.       <tr>
    286. 

  286.         <td><span class="xref">System.Boolean</span></td>
    287. 

  287.         <td><span class="parametername">disposing</span></td>
    288. 

  288.         <td></td>
    289. 

  289.       </tr>
    290. 

  290.     </tbody>
    291. 

  291.   </table>
    292. 

  292.   <a id="UICatalog_Scenario_GetCategories_" data-uid="UICatalog.Scenario.GetCategories*"></a>
    293. 

  293.   <h4 id="UICatalog_Scenario_GetCategories" data-uid="UICatalog.Scenario.GetCategories">GetCategories()</h4>
    294. 

  294.   <div class="markdown level1 summary"><p>Helper function to get the list of categories a <a class="xref" href="UICatalog.Scenario.html">Scenario</a> belongs to (defined in <a class="xref" href="UICatalog.Scenario.ScenarioCategory.html">Scenario.ScenarioCategory</a>)</p>
    295. 

  295. </div>
    296. 

  296.   <div class="markdown level1 conceptual"></div>
    297. 

  297.   <h5 class="decalaration">Declaration</h5>
    298. 

  298.   <div class="codewrapper">
    299. 

  299.     <pre><code class="lang-csharp hljs">public List&lt;string&gt; GetCategories()</code></pre>
    300. 

  300.   </div>
    301. 

  301.   <h5 class="returns">Returns</h5>
    302. 

  302.   <table class="table table-bordered table-striped table-condensed">
    303. 

  303.     <thead>
    304. 

  304.       <tr>
    305. 

  305.         <th>Type</th>
    306. 

  306.         <th>Description</th>
    307. 

  307.       </tr>
    308. 

  308.     </thead>
    309. 

  309.     <tbody>
    310. 

  310.       <tr>
    311. 

  311.         <td><span class="xref">System.Collections.Generic.List</span>&lt;<span class="xref">System.String</span>&gt;</td>
    312. 

  312.         <td><p>list of category names</p>
    313. 

  313. </td>
    314. 

  314.       </tr>
    315. 

  315.     </tbody>
    316. 

  316.   </table>
    317. 

  317.   <a id="UICatalog_Scenario_GetDerivedClasses_" data-uid="UICatalog.Scenario.GetDerivedClasses*"></a>
    318. 

  318.   <h4 id="UICatalog_Scenario_GetDerivedClasses__1" data-uid="UICatalog.Scenario.GetDerivedClasses``1">GetDerivedClasses&lt;T&gt;()</h4>
    319. 

  319.   <div class="markdown level1 summary"><p>Returns an instance of each <a class="xref" href="UICatalog.Scenario.html">Scenario</a> defined in the project. 
    320. 

  320. <a href="https://stackoverflow.com/questions/5411694/get-all-inherited-classes-of-an-abstract-class">https://stackoverflow.com/questions/5411694/get-all-inherited-classes-of-an-abstract-class</a></p>
    321. 

  321. </div>
    322. 

  322.   <div class="markdown level1 conceptual"></div>
    323. 

  323.   <h5 class="decalaration">Declaration</h5>
    324. 

  324.   <div class="codewrapper">
    325. 

  325.     <pre><code class="lang-csharp hljs">public static List&lt;Type&gt; GetDerivedClasses&lt;T&gt;()</code></pre>
    326. 

  326.   </div>
    327. 

  327.   <h5 class="returns">Returns</h5>
    328. 

  328.   <table class="table table-bordered table-striped table-condensed">
    329. 

  329.     <thead>
    330. 

  330.       <tr>
    331. 

  331.         <th>Type</th>
    332. 

  332.         <th>Description</th>
    333. 

  333.       </tr>
    334. 

  334.     </thead>
    335. 

  335.     <tbody>
    336. 

  336.       <tr>
    337. 

  337.         <td><span class="xref">System.Collections.Generic.List</span>&lt;<span class="xref">System.Type</span>&gt;</td>
    338. 

  338.         <td></td>
    339. 

  339.       </tr>
    340. 

  340.     </tbody>
    341. 

  341.   </table>
    342. 

  342.   <h5 class="typeParameters">Type Parameters</h5>
    343. 

  343.   <table class="table table-bordered table-striped table-condensed">
    344. 

  344.     <thead>
    345. 

  345.       <tr>
    346. 

  346.         <th>Name</th>
    347. 

  347.         <th>Description</th>
    348. 

  348.       </tr>
    349. 

  349.     </thead>
    350. 

  350.     <tbody>
    351. 

  351.       <tr>
    352. 

  352.         <td><span class="parametername">T</span></td>
    353. 

  353.         <td></td>
    354. 

  354.       </tr>
    355. 

  355.     </tbody>
    356. 

  356.   </table>
    357. 

  357.   <a id="UICatalog_Scenario_GetDescription_" data-uid="UICatalog.Scenario.GetDescription*"></a>
    358. 

  358.   <h4 id="UICatalog_Scenario_GetDescription" data-uid="UICatalog.Scenario.GetDescription">GetDescription()</h4>
    359. 

  359.   <div class="markdown level1 summary"><p>Helper to get the <a class="xref" href="UICatalog.Scenario.html">Scenario</a> Description (defined in <a class="xref" href="UICatalog.Scenario.ScenarioMetadata.html">Scenario.ScenarioMetadata</a>)</p>
    360. 

  360. </div>
    361. 

  361.   <div class="markdown level1 conceptual"></div>
    362. 

  362.   <h5 class="decalaration">Declaration</h5>
    363. 

  363.   <div class="codewrapper">
    364. 

  364.     <pre><code class="lang-csharp hljs">public string GetDescription()</code></pre>
    365. 

  365.   </div>
    366. 

  366.   <h5 class="returns">Returns</h5>
    367. 

  367.   <table class="table table-bordered table-striped table-condensed">
    368. 

  368.     <thead>
    369. 

  369.       <tr>
    370. 

  370.         <th>Type</th>
    371. 

  371.         <th>Description</th>
    372. 

  372.       </tr>
    373. 

  373.     </thead>
    374. 

  374.     <tbody>
    375. 

  375.       <tr>
    376. 

  376.         <td><span class="xref">System.String</span></td>
    377. 

  377.         <td></td>
    378. 

  378.       </tr>
    379. 

  379.     </tbody>
    380. 

  380.   </table>
    381. 

  381.   <a id="UICatalog_Scenario_GetName_" data-uid="UICatalog.Scenario.GetName*"></a>
    382. 

  382.   <h4 id="UICatalog_Scenario_GetName" data-uid="UICatalog.Scenario.GetName">GetName()</h4>
    383. 

  383.   <div class="markdown level1 summary"><p>Helper to get the <a class="xref" href="UICatalog.Scenario.html">Scenario</a> Name (defined in <a class="xref" href="UICatalog.Scenario.ScenarioMetadata.html">Scenario.ScenarioMetadata</a>)</p>
    384. 

  384. </div>
    385. 

  385.   <div class="markdown level1 conceptual"></div>
    386. 

  386.   <h5 class="decalaration">Declaration</h5>
    387. 

  387.   <div class="codewrapper">
    388. 

  388.     <pre><code class="lang-csharp hljs">public string GetName()</code></pre>
    389. 

  389.   </div>
    390. 

  390.   <h5 class="returns">Returns</h5>
    391. 

  391.   <table class="table table-bordered table-striped table-condensed">
    392. 

  392.     <thead>
    393. 

  393.       <tr>
    394. 

  394.         <th>Type</th>
    395. 

  395.         <th>Description</th>
    396. 

  396.       </tr>
    397. 

  397.     </thead>
    398. 

  398.     <tbody>
    399. 

  399.       <tr>
    400. 

  400.         <td><span class="xref">System.String</span></td>
    401. 

  401.         <td></td>
    402. 

  402.       </tr>
    403. 

  403.     </tbody>
    404. 

  404.   </table>
    405. 

  405.   <a id="UICatalog_Scenario_Init_" data-uid="UICatalog.Scenario.Init*"></a>
    406. 

  406.   <h4 id="UICatalog_Scenario_Init_Terminal_Gui_Toplevel_Terminal_Gui_ColorScheme_" data-uid="UICatalog.Scenario.Init(Terminal.Gui.Toplevel,Terminal.Gui.ColorScheme)">Init(Toplevel, ColorScheme)</h4>
    407. 

  407.   <div class="markdown level1 summary"><p>Helper that provides the default <a class="xref" href="../Terminal.Gui/Terminal.Gui.Window.html">Window</a> implementation with a frame and 
    408. 

  408. label showing the name of the <a class="xref" href="UICatalog.Scenario.html">Scenario</a> and logic to exit back to 
    409. 

  409. the Scenario picker UI.
    410. 

  410. Override <a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Init_Terminal_Gui_Toplevel_Terminal_Gui_ColorScheme_">Init(Toplevel, ColorScheme)</a> to provide any <a class="xref" href="../Terminal.Gui/Terminal.Gui.Toplevel.html">Toplevel</a> behavior needed.</p>
    411. 

  411. </div>
    412. 

  412.   <div class="markdown level1 conceptual"></div>
    413. 

  413.   <h5 class="decalaration">Declaration</h5>
    414. 

  414.   <div class="codewrapper">
    415. 

  415.     <pre><code class="lang-csharp hljs">public virtual void Init(Toplevel top, ColorScheme colorScheme)</code></pre>
    416. 

  416.   </div>
    417. 

  417.   <h5 class="parameters">Parameters</h5>
    418. 

  418.   <table class="table table-bordered table-striped table-condensed">
    419. 

  419.     <thead>
    420. 

  420.       <tr>
    421. 

  421.         <th>Type</th>
    422. 

  422.         <th>Name</th>
    423. 

  423.         <th>Description</th>
    424. 

  424.       </tr>
    425. 

  425.     </thead>
    426. 

  426.     <tbody>
    427. 

  427.       <tr>
    428. 

  428.         <td><a class="xref" href="../Terminal.Gui/Terminal.Gui.Toplevel.html">Toplevel</a></td>
    429. 

  429.         <td><span class="parametername">top</span></td>
    430. 

  430.         <td><p>The Toplevel created by the UI Catalog host.</p>
    431. 

  431. </td>
    432. 

  432.       </tr>
    433. 

  433.       <tr>
    434. 

  434.         <td><a class="xref" href="../Terminal.Gui/Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
    435. 

  435.         <td><span class="parametername">colorScheme</span></td>
    436. 

  436.         <td><p>The colorscheme to use.</p>
    437. 

  437. </td>
    438. 

  438.       </tr>
    439. 

  439.     </tbody>
    440. 

  440.   </table>
    441. 

  441.   <h5 id="UICatalog_Scenario_Init_Terminal_Gui_Toplevel_Terminal_Gui_ColorScheme__remarks">Remarks</h5>
    442. 

  442.   <div class="markdown level1 remarks"><p>
    443. 

  443. The base implementation calls <a class="xref" href="../Terminal.Gui/Terminal.Gui.Application.html#Terminal_Gui_Application_Init_Terminal_Gui_ConsoleDriver_Terminal_Gui_IMainLoopDriver_">Init(ConsoleDriver, IMainLoopDriver)</a>, sets <a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Top">Top</a> to the passed in <a class="xref" href="../Terminal.Gui/Terminal.Gui.Toplevel.html">Toplevel</a>, creates a <a class="xref" href="../Terminal.Gui/Terminal.Gui.Window.html">Window</a> for <a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Win">Win</a> and adds it to <a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Top">Top</a>.
    444. 

  444. </p>
    445. 

  445. <p>
    446. 

  446. Overrides that do not call the base.<a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Run">Run()</a>, must call <a class="xref" href="../Terminal.Gui/Terminal.Gui.Application.html#Terminal_Gui_Application_Init_Terminal_Gui_ConsoleDriver_Terminal_Gui_IMainLoopDriver_">Init(ConsoleDriver, IMainLoopDriver)</a> before creating any views or calling other Terminal.Gui APIs.
    447. 

  447. </p>
    448. 

  448. </div>
    449. 

  449.   <a id="UICatalog_Scenario_RequestStop_" data-uid="UICatalog.Scenario.RequestStop*"></a>
    450. 

  450.   <h4 id="UICatalog_Scenario_RequestStop" data-uid="UICatalog.Scenario.RequestStop">RequestStop()</h4>
    451. 

  451.   <div class="markdown level1 summary"><p>Stops the scenario. Override to change shutdown behavior for the <a class="xref" href="UICatalog.Scenario.html">Scenario</a>.</p>
    452. 

  452. </div>
    453. 

  453.   <div class="markdown level1 conceptual"></div>
    454. 

  454.   <h5 class="decalaration">Declaration</h5>
    455. 

  455.   <div class="codewrapper">
    456. 

  456.     <pre><code class="lang-csharp hljs">public virtual void RequestStop()</code></pre>
    457. 

  457.   </div>
    458. 

  458.   <a id="UICatalog_Scenario_Run_" data-uid="UICatalog.Scenario.Run*"></a>
    459. 

  459.   <h4 id="UICatalog_Scenario_Run" data-uid="UICatalog.Scenario.Run">Run()</h4>
    460. 

  460.   <div class="markdown level1 summary"><p>Runs the <a class="xref" href="UICatalog.Scenario.html">Scenario</a>. Override to start the <a class="xref" href="UICatalog.Scenario.html">Scenario</a> using a <a class="xref" href="../Terminal.Gui/Terminal.Gui.Toplevel.html">Toplevel</a> different than <code>Top</code>.</p>
    461. 

  461. </div>
    462. 

  462.   <div class="markdown level1 conceptual"></div>
    463. 

  463.   <h5 class="decalaration">Declaration</h5>
    464. 

  464.   <div class="codewrapper">
    465. 

  465.     <pre><code class="lang-csharp hljs">public virtual void Run()</code></pre>
    466. 

  466.   </div>
    467. 

  467.   <h5 id="UICatalog_Scenario_Run_remarks">Remarks</h5>
    468. 

  468.   <div class="markdown level1 remarks"><p>Overrides that do not call the base.<a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Run">Run()</a>, must call <a class="xref" href="../Terminal.Gui/Terminal.Gui.Application.html#Terminal_Gui_Application_Shutdown">Shutdown()</a> before returning.</p>
    469. 

  469. </div>
    470. 

  470.   <a id="UICatalog_Scenario_Setup_" data-uid="UICatalog.Scenario.Setup*"></a>
    471. 

  471.   <h4 id="UICatalog_Scenario_Setup" data-uid="UICatalog.Scenario.Setup">Setup()</h4>
    472. 

  472.   <div class="markdown level1 summary"><p>Override this to implement the <a class="xref" href="UICatalog.Scenario.html">Scenario</a> setup logic (create controls, etc...). </p>
    473. 

  473. </div>
    474. 

  474.   <div class="markdown level1 conceptual"></div>
    475. 

  475.   <h5 class="decalaration">Declaration</h5>
    476. 

  476.   <div class="codewrapper">
    477. 

  477.     <pre><code class="lang-csharp hljs">public virtual void Setup()</code></pre>
    478. 

  478.   </div>
    479. 

  479.   <h5 id="UICatalog_Scenario_Setup_remarks">Remarks</h5>
    480. 

  480.   <div class="markdown level1 remarks"><p>This is typically the best place to put scenario logic code.</p>
    481. 

  481. </div>
    482. 

  482.   <a id="UICatalog_Scenario_ToString_" data-uid="UICatalog.Scenario.ToString*"></a>
    483. 

  483.   <h4 id="UICatalog_Scenario_ToString" data-uid="UICatalog.Scenario.ToString">ToString()</h4>
    484. 

  484.   <div class="markdown level1 summary"></div>
    485. 

  485.   <div class="markdown level1 conceptual"></div>
    486. 

  486.   <h5 class="decalaration">Declaration</h5>
    487. 

  487.   <div class="codewrapper">
    488. 

  488.     <pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
    489. 

  489.   </div>
    490. 

  490.   <h5 class="returns">Returns</h5>
    491. 

  491.   <table class="table table-bordered table-striped table-condensed">
    492. 

  492.     <thead>
    493. 

  493.       <tr>
    494. 

  494.         <th>Type</th>
    495. 

  495.         <th>Description</th>
    496. 

  496.       </tr>
    497. 

  497.     </thead>
    498. 

  498.     <tbody>
    499. 

  499.       <tr>
    500. 

  500.         <td><span class="xref">System.String</span></td>
    501. 

  501.         <td></td>
    502. 

  502.       </tr>
    503. 

  503.     </tbody>
    504. 

  504.   </table>
    505. 

  505.   <h5 class="overrides">Overrides</h5>
    506. 

  506.   <div><span class="xref">System.Object.ToString()</span></div>
    507. 

  507.   <h3 id="implements">Implements</h3>
    508. 

  508.   <div>
    509. 

  509.       <span class="xref">System.IDisposable</span>
    510. 

  510.   </div>
    511. 

  511. </article>
    512. 

  512.           </div>
    513. 

  513.           
    514. 

  514.           <div class="hidden-sm col-md-2" role="complementary">
    515. 

  515.             <div class="sideaffix">
    516. 

  516.               <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
    517. 

  517.                 <h5>In This Article</h5>
    518. 

  518.                 <div></div>
    519. 

  519.               </nav>
    520. 

  520.             </div>
    521. 

  521.           </div>
    522. 

  522.         </div>
    523. 

  523.       </div>
    524. 

  524.       
    525. 

  525.       <footer>
    526. 

  526.         <div class="grad-bottom"></div>
    527. 

  527.         <div class="footer">
    528. 

  528.           <div class="container">
    529. 

  529.             <span class="pull-right">
    530. 

  530.               <a href="#top">Back to top</a>
    531. 

  531.             </span>
    532. 

  532.             
    533. 

  533.             <span>Generated by <strong>DocFX</strong></span>
    534. 

  534.           </div>
    535. 

  535.         </div>
    536. 

  536.       </footer>
    537. 

  537.     </div>
    538. 

  538.     
    539. 

  539.     <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
    540. 

  540.     <script type="text/javascript" src="../../styles/docfx.js"></script>
    541. 

  541.     <script type="text/javascript" src="../../styles/main.js"></script>
    542. 

  542.   </body>
    543. 

  543. </html>
    544.