UICatalog.Scenario.html 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518
  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 Scenario
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Scenario
  11. ">
  12. <meta name="generator" content="docfx 2.56.2.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"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></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="UICatalog.Scenario">
  73. <h1 id="UICatalog_Scenario" data-uid="UICatalog.Scenario" class="text-break">Class Scenario
  74. </h1>
  75. <div class="markdown level0 summary"><p>Base class for each demo/scenario.</p>
  76. <p>
  77. To define a new scenario:
  78. <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 <see cref="!:Scenario.ScenarioMetaData"></see> 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 sceanrio belongs to. If you don&apos;t specify a category the sceanrio 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 <see cref="!:Init(Toplevel)"></see> and/or <a class="xref" href="UICatalog.Scenario.html#UICatalog_Scenario_Run">Run()</a> overrides to provide a custom implementation.</li></ol>
  79. </p>
  80. <p>
  81. The UI Catalog program uses reflection to find all scenarios and adds them to the
  82. ListViews. Press ENTER to run the selected scenario. Press CTRL-Q to exit it. /
  83. </p>
  84. </div>
  85. <div class="markdown level0 conceptual"></div>
  86. <div class="inheritance">
  87. <h5>Inheritance</h5>
  88. <div class="level0"><span class="xref">System.Object</span></div>
  89. <div class="level1"><span class="xref">Scenario</span></div>
  90. </div>
  91. <div classs="implements">
  92. <h5>Implements</h5>
  93. <div><span class="xref">System.IDisposable</span></div>
  94. </div>
  95. <div class="inheritedMembers">
  96. <h5>Inherited Members</h5>
  97. <div>
  98. <span class="xref">System.Object.Equals(System.Object)</span>
  99. </div>
  100. <div>
  101. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  102. </div>
  103. <div>
  104. <span class="xref">System.Object.GetHashCode()</span>
  105. </div>
  106. <div>
  107. <span class="xref">System.Object.GetType()</span>
  108. </div>
  109. <div>
  110. <span class="xref">System.Object.MemberwiseClone()</span>
  111. </div>
  112. <div>
  113. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  114. </div>
  115. </div>
  116. <h6><strong>Namespace</strong>: <a class="xref" href="UICatalog.html">UICatalog</a></h6>
  117. <h6><strong>Assembly</strong>: UICatalog.dll</h6>
  118. <h5 id="UICatalog_Scenario_syntax">Syntax</h5>
  119. <div class="codewrapper">
  120. <pre><code class="lang-csharp hljs">public class Scenario : IDisposable</code></pre>
  121. </div>
  122. <h5 id="UICatalog_Scenario_examples"><strong>Examples</strong></h5>
  123. <p>The example below is provided in the <code>Scenarios</code> directory as a generic sample that can be copied and re-named:</p>
  124. <pre><code>using Terminal.Gui;
  125. namespace UICatalog {
  126. [ScenarioMetadata (Name: &quot;Generic&quot;, Description: &quot;Generic sample - A template for creating new Scenarios&quot;)]
  127. [ScenarioCategory (&quot;Controls&quot;)]
  128. class MyScenario : Scenario {
  129. public override void Setup ()
  130. {
  131. // Put your scenario code here, e.g.
  132. Win.Add (new Button (&quot;Press me!&quot;) {
  133. X = Pos.Center (),
  134. Y = Pos.Center (),
  135. Clicked = () => MessageBox.Query (20, 7, &quot;Hi&quot;, &quot;Neat?&quot;, &quot;Yes&quot;, &quot;No&quot;)
  136. });
  137. }
  138. }
  139. }</code></pre>
  140. <h3 id="properties">Properties
  141. </h3>
  142. <a id="UICatalog_Scenario_Top_" data-uid="UICatalog.Scenario.Top*"></a>
  143. <h4 id="UICatalog_Scenario_Top" data-uid="UICatalog.Scenario.Top">Top</h4>
  144. <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>
  145. </div>
  146. <div class="markdown level1 conceptual"></div>
  147. <h5 class="decalaration">Declaration</h5>
  148. <div class="codewrapper">
  149. <pre><code class="lang-csharp hljs">public Toplevel Top { get; set; }</code></pre>
  150. </div>
  151. <h5 class="propertyValue">Property Value</h5>
  152. <table class="table table-bordered table-striped table-condensed">
  153. <thead>
  154. <tr>
  155. <th>Type</th>
  156. <th>Description</th>
  157. </tr>
  158. </thead>
  159. <tbody>
  160. <tr>
  161. <td><a class="xref" href="../Terminal.Gui/Terminal.Gui.Toplevel.html">Toplevel</a></td>
  162. <td></td>
  163. </tr>
  164. </tbody>
  165. </table>
  166. <a id="UICatalog_Scenario_Win_" data-uid="UICatalog.Scenario.Win*"></a>
  167. <h4 id="UICatalog_Scenario_Win" data-uid="UICatalog.Scenario.Win">Win</h4>
  168. <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>
  169. </div>
  170. <div class="markdown level1 conceptual"></div>
  171. <h5 class="decalaration">Declaration</h5>
  172. <div class="codewrapper">
  173. <pre><code class="lang-csharp hljs">public Window Win { get; set; }</code></pre>
  174. </div>
  175. <h5 class="propertyValue">Property Value</h5>
  176. <table class="table table-bordered table-striped table-condensed">
  177. <thead>
  178. <tr>
  179. <th>Type</th>
  180. <th>Description</th>
  181. </tr>
  182. </thead>
  183. <tbody>
  184. <tr>
  185. <td><a class="xref" href="../Terminal.Gui/Terminal.Gui.Window.html">Window</a></td>
  186. <td></td>
  187. </tr>
  188. </tbody>
  189. </table>
  190. <h3 id="methods">Methods
  191. </h3>
  192. <a id="UICatalog_Scenario_Dispose_" data-uid="UICatalog.Scenario.Dispose*"></a>
  193. <h4 id="UICatalog_Scenario_Dispose" data-uid="UICatalog.Scenario.Dispose">Dispose()</h4>
  194. <div class="markdown level1 summary"></div>
  195. <div class="markdown level1 conceptual"></div>
  196. <h5 class="decalaration">Declaration</h5>
  197. <div class="codewrapper">
  198. <pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
  199. </div>
  200. <a id="UICatalog_Scenario_Dispose_" data-uid="UICatalog.Scenario.Dispose*"></a>
  201. <h4 id="UICatalog_Scenario_Dispose_System_Boolean_" data-uid="UICatalog.Scenario.Dispose(System.Boolean)">Dispose(Boolean)</h4>
  202. <div class="markdown level1 summary"></div>
  203. <div class="markdown level1 conceptual"></div>
  204. <h5 class="decalaration">Declaration</h5>
  205. <div class="codewrapper">
  206. <pre><code class="lang-csharp hljs">protected virtual void Dispose(bool disposing)</code></pre>
  207. </div>
  208. <h5 class="parameters">Parameters</h5>
  209. <table class="table table-bordered table-striped table-condensed">
  210. <thead>
  211. <tr>
  212. <th>Type</th>
  213. <th>Name</th>
  214. <th>Description</th>
  215. </tr>
  216. </thead>
  217. <tbody>
  218. <tr>
  219. <td><span class="xref">System.Boolean</span></td>
  220. <td><span class="parametername">disposing</span></td>
  221. <td></td>
  222. </tr>
  223. </tbody>
  224. </table>
  225. <a id="UICatalog_Scenario_GetCategories_" data-uid="UICatalog.Scenario.GetCategories*"></a>
  226. <h4 id="UICatalog_Scenario_GetCategories" data-uid="UICatalog.Scenario.GetCategories">GetCategories()</h4>
  227. <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>
  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 List&lt;string&gt; GetCategories()</code></pre>
  233. </div>
  234. <h5 class="returns">Returns</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><span class="xref">System.Collections.Generic.List</span>&lt;<span class="xref">System.String</span>&gt;</td>
  245. <td><p>list of category names</p>
  246. </td>
  247. </tr>
  248. </tbody>
  249. </table>
  250. <a id="UICatalog_Scenario_GetDerivedClasses_" data-uid="UICatalog.Scenario.GetDerivedClasses*"></a>
  251. <h4 id="UICatalog_Scenario_GetDerivedClasses__1" data-uid="UICatalog.Scenario.GetDerivedClasses``1">GetDerivedClasses&lt;T&gt;()</h4>
  252. <div class="markdown level1 summary"><p>Returns an instance of each <a class="xref" href="UICatalog.Scenario.html">Scenario</a> defined in the project.
  253. <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>
  254. </div>
  255. <div class="markdown level1 conceptual"></div>
  256. <h5 class="decalaration">Declaration</h5>
  257. <div class="codewrapper">
  258. <pre><code class="lang-csharp hljs">public static List&lt;Type&gt; GetDerivedClasses&lt;T&gt;()</code></pre>
  259. </div>
  260. <h5 class="returns">Returns</h5>
  261. <table class="table table-bordered table-striped table-condensed">
  262. <thead>
  263. <tr>
  264. <th>Type</th>
  265. <th>Description</th>
  266. </tr>
  267. </thead>
  268. <tbody>
  269. <tr>
  270. <td><span class="xref">System.Collections.Generic.List</span>&lt;<span class="xref">System.Type</span>&gt;</td>
  271. <td></td>
  272. </tr>
  273. </tbody>
  274. </table>
  275. <h5 class="typeParameters">Type Parameters</h5>
  276. <table class="table table-bordered table-striped table-condensed">
  277. <thead>
  278. <tr>
  279. <th>Name</th>
  280. <th>Description</th>
  281. </tr>
  282. </thead>
  283. <tbody>
  284. <tr>
  285. <td><span class="parametername">T</span></td>
  286. <td></td>
  287. </tr>
  288. </tbody>
  289. </table>
  290. <a id="UICatalog_Scenario_GetDescription_" data-uid="UICatalog.Scenario.GetDescription*"></a>
  291. <h4 id="UICatalog_Scenario_GetDescription" data-uid="UICatalog.Scenario.GetDescription">GetDescription()</h4>
  292. <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>
  293. </div>
  294. <div class="markdown level1 conceptual"></div>
  295. <h5 class="decalaration">Declaration</h5>
  296. <div class="codewrapper">
  297. <pre><code class="lang-csharp hljs">public string GetDescription()</code></pre>
  298. </div>
  299. <h5 class="returns">Returns</h5>
  300. <table class="table table-bordered table-striped table-condensed">
  301. <thead>
  302. <tr>
  303. <th>Type</th>
  304. <th>Description</th>
  305. </tr>
  306. </thead>
  307. <tbody>
  308. <tr>
  309. <td><span class="xref">System.String</span></td>
  310. <td></td>
  311. </tr>
  312. </tbody>
  313. </table>
  314. <a id="UICatalog_Scenario_GetName_" data-uid="UICatalog.Scenario.GetName*"></a>
  315. <h4 id="UICatalog_Scenario_GetName" data-uid="UICatalog.Scenario.GetName">GetName()</h4>
  316. <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>
  317. </div>
  318. <div class="markdown level1 conceptual"></div>
  319. <h5 class="decalaration">Declaration</h5>
  320. <div class="codewrapper">
  321. <pre><code class="lang-csharp hljs">public string GetName()</code></pre>
  322. </div>
  323. <h5 class="returns">Returns</h5>
  324. <table class="table table-bordered table-striped table-condensed">
  325. <thead>
  326. <tr>
  327. <th>Type</th>
  328. <th>Description</th>
  329. </tr>
  330. </thead>
  331. <tbody>
  332. <tr>
  333. <td><span class="xref">System.String</span></td>
  334. <td></td>
  335. </tr>
  336. </tbody>
  337. </table>
  338. <a id="UICatalog_Scenario_Init_" data-uid="UICatalog.Scenario.Init*"></a>
  339. <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>
  340. <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
  341. label showing the name of the <a class="xref" href="UICatalog.Scenario.html">Scenario</a> and logic to exit back to
  342. the Scenario picker UI.
  343. Override <see cref="!:Init(Toplevel)"></see> to provide any <a class="xref" href="../Terminal.Gui/Terminal.Gui.Toplevel.html">Toplevel</a> behavior needed.</p>
  344. </div>
  345. <div class="markdown level1 conceptual"></div>
  346. <h5 class="decalaration">Declaration</h5>
  347. <div class="codewrapper">
  348. <pre><code class="lang-csharp hljs">public virtual void Init(Toplevel top, ColorScheme colorScheme)</code></pre>
  349. </div>
  350. <h5 class="parameters">Parameters</h5>
  351. <table class="table table-bordered table-striped table-condensed">
  352. <thead>
  353. <tr>
  354. <th>Type</th>
  355. <th>Name</th>
  356. <th>Description</th>
  357. </tr>
  358. </thead>
  359. <tbody>
  360. <tr>
  361. <td><a class="xref" href="../Terminal.Gui/Terminal.Gui.Toplevel.html">Toplevel</a></td>
  362. <td><span class="parametername">top</span></td>
  363. <td><p>The Toplevel created by the UI Catalog host.</p>
  364. </td>
  365. </tr>
  366. <tr>
  367. <td><a class="xref" href="../Terminal.Gui/Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  368. <td><span class="parametername">colorScheme</span></td>
  369. <td><p>The colorscheme to use.</p>
  370. </td>
  371. </tr>
  372. </tbody>
  373. </table>
  374. <h5 id="UICatalog_Scenario_Init_Terminal_Gui_Toplevel_Terminal_Gui_ColorScheme__remarks">Remarks</h5>
  375. <div class="markdown level1 remarks"><p>
  376. Thg 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>.
  377. </p>
  378. <p>
  379. 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.
  380. </p>
  381. </div>
  382. <a id="UICatalog_Scenario_RequestStop_" data-uid="UICatalog.Scenario.RequestStop*"></a>
  383. <h4 id="UICatalog_Scenario_RequestStop" data-uid="UICatalog.Scenario.RequestStop">RequestStop()</h4>
  384. <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>
  385. </div>
  386. <div class="markdown level1 conceptual"></div>
  387. <h5 class="decalaration">Declaration</h5>
  388. <div class="codewrapper">
  389. <pre><code class="lang-csharp hljs">public virtual void RequestStop()</code></pre>
  390. </div>
  391. <a id="UICatalog_Scenario_Run_" data-uid="UICatalog.Scenario.Run*"></a>
  392. <h4 id="UICatalog_Scenario_Run" data-uid="UICatalog.Scenario.Run">Run()</h4>
  393. <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>
  394. </div>
  395. <div class="markdown level1 conceptual"></div>
  396. <h5 class="decalaration">Declaration</h5>
  397. <div class="codewrapper">
  398. <pre><code class="lang-csharp hljs">public virtual void Run()</code></pre>
  399. </div>
  400. <h5 id="UICatalog_Scenario_Run_remarks">Remarks</h5>
  401. <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>
  402. </div>
  403. <a id="UICatalog_Scenario_Setup_" data-uid="UICatalog.Scenario.Setup*"></a>
  404. <h4 id="UICatalog_Scenario_Setup" data-uid="UICatalog.Scenario.Setup">Setup()</h4>
  405. <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>
  406. </div>
  407. <div class="markdown level1 conceptual"></div>
  408. <h5 class="decalaration">Declaration</h5>
  409. <div class="codewrapper">
  410. <pre><code class="lang-csharp hljs">public virtual void Setup()</code></pre>
  411. </div>
  412. <h5 id="UICatalog_Scenario_Setup_remarks">Remarks</h5>
  413. <div class="markdown level1 remarks"><p>This is typically the best place to put scenario logic code.</p>
  414. </div>
  415. <a id="UICatalog_Scenario_ToString_" data-uid="UICatalog.Scenario.ToString*"></a>
  416. <h4 id="UICatalog_Scenario_ToString" data-uid="UICatalog.Scenario.ToString">ToString()</h4>
  417. <div class="markdown level1 summary"></div>
  418. <div class="markdown level1 conceptual"></div>
  419. <h5 class="decalaration">Declaration</h5>
  420. <div class="codewrapper">
  421. <pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
  422. </div>
  423. <h5 class="returns">Returns</h5>
  424. <table class="table table-bordered table-striped table-condensed">
  425. <thead>
  426. <tr>
  427. <th>Type</th>
  428. <th>Description</th>
  429. </tr>
  430. </thead>
  431. <tbody>
  432. <tr>
  433. <td><span class="xref">System.String</span></td>
  434. <td></td>
  435. </tr>
  436. </tbody>
  437. </table>
  438. <h5 class="overrides">Overrides</h5>
  439. <div><span class="xref">System.Object.ToString()</span></div>
  440. <h3 id="implements">Implements</h3>
  441. <div>
  442. <span class="xref">System.IDisposable</span>
  443. </div>
  444. </article>
  445. </div>
  446. <div class="hidden-sm col-md-2" role="complementary">
  447. <div class="sideaffix">
  448. <div class="contribution">
  449. <ul class="nav">
  450. </ul>
  451. </div>
  452. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  453. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  454. </nav>
  455. </div>
  456. </div>
  457. </div>
  458. </div>
  459. <footer>
  460. <div class="grad-bottom"></div>
  461. <div class="footer">
  462. <div class="container">
  463. <span class="pull-right">
  464. <a href="#top">Back to top</a>
  465. </span>
  466. <span>Generated by <strong>DocFX</strong></span>
  467. </div>
  468. </div>
  469. </footer>
  470. </div>
  471. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  472. <script type="text/javascript" src="../../styles/docfx.js"></script>
  473. <script type="text/javascript" src="../../styles/main.js"></script>
  474. </body>
  475. </html>