Terminal.Gui.View.html 60 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571
  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 View
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class View
  11. ">
  12. <meta name="generator" content="docfx 2.18.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="">
  18. <meta property="docfx:tocrel" content="../toc.html">
  19. </head>
  20. <body data-spy="scroll" data-target="#affix">
  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="../../logo.svg" 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 role="main" class="container body-content hide-when-search">
  54. <div class="sidenav hide-when-search">
  55. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  56. <div class="sidetoggle collapse" id="sidetoggle">
  57. <div id="sidetoc"></div>
  58. </div>
  59. </div>
  60. <div class="article row grid-right">
  61. <div class="col-md-10">
  62. <article class="content wrap" id="_content" data-uid="Terminal.Gui.View">
  63. <h1 id="Terminal_Gui_View" data-uid="Terminal.Gui.View">Class View
  64. </h1>
  65. <div class="markdown level0 summary"><p>View is the base class for all views on the screen and represents a visible element that can render itself and contains zero or more nested views.</p>
  66. </div>
  67. <div class="markdown level0 conceptual"></div>
  68. <div class="inheritance">
  69. <h5>Inheritance</h5>
  70. <div class="level0"><span class="xref">System.Object</span></div>
  71. <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
  72. <div class="level2"><span class="xref">View</span></div>
  73. </div>
  74. <div class="level3"><a class="xref" href="Terminal.Gui.Button.html">Button</a></div>
  75. <div class="level3"><a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a></div>
  76. <div class="level3"><a class="xref" href="Terminal.Gui.FrameView.html">FrameView</a></div>
  77. <div class="level3"><a class="xref" href="Terminal.Gui.Label.html">Label</a></div>
  78. <div class="level3"><a class="xref" href="Terminal.Gui.ListView.html">ListView</a></div>
  79. <div class="level3"><a class="xref" href="Terminal.Gui.MenuBar.html">MenuBar</a></div>
  80. <div class="level3"><a class="xref" href="Terminal.Gui.ProgressBar.html">ProgressBar</a></div>
  81. <div class="level3"><a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a></div>
  82. <div class="level3"><a class="xref" href="Terminal.Gui.ScrollBarView.html">ScrollBarView</a></div>
  83. <div class="level3"><a class="xref" href="Terminal.Gui.ScrollView.html">ScrollView</a></div>
  84. <div class="level3"><a class="xref" href="Terminal.Gui.TextField.html">TextField</a></div>
  85. <div class="level3"><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></div>
  86. <div class="inheritedMembers">
  87. <h5>Inherited Members</h5>
  88. <div>
  89. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_CanFocus">Responder.CanFocus</a>
  90. </div>
  91. <div>
  92. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a>
  93. </div>
  94. </div>
  95. <h6><strong>Namespace</strong>: <a class="xref" href="../Terminal.Gui.html">Terminal.Gui</a></h6>
  96. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  97. <h5 id="Terminal_Gui_View_syntax">Syntax</h5>
  98. <div class="codewrapper">
  99. <pre><code class="lang-csharp hljs">public class View : Terminal.Gui.Responder, System.Collections.IEnumerable</code></pre>
  100. </div>
  101. <h5 id="Terminal_Gui_View_remarks"><strong>Remarks</strong></h5>
  102. <div class="markdown level0 remarks"><p>
  103. The View defines the base functionality for user interface elements in Terminal/gui.cs. Views
  104. can contain one or more subviews, can respond to user input and render themselves on the screen.
  105. </p>
  106. <p>
  107. Views are created with a specified rectangle region (the frame) that is relative to the container
  108. that they are added into.<br> </p>
  109. <p>
  110. Subviews can be added to a View by calling the Add method. The container of a view is the
  111. Superview.
  112. </p>
  113. <p>
  114. Developers can call the SetNeedsDisplay method on the view to flag a region or the entire view
  115. as requiring to be redrawn.
  116. </p>
  117. <p>
  118. Views have a ColorScheme property that defines the default colors that subviews
  119. should use for rendering. This ensures that the views fit in the context where
  120. they are being used, and allows for themes to be plugged in. For example, the
  121. default colors for windows and toplevels uses a blue background, while it uses
  122. a white background for dialog boxes and a red background for errors.
  123. </p>
  124. <p>
  125. If a ColorScheme is not set on a view, the result of the ColorScheme is the
  126. value of the SuperView and the value might only be valid once a view has been
  127. added to a SuperView, so your subclasses should not rely on ColorScheme being
  128. set at construction time.
  129. </p>
  130. <p>
  131. Using ColorSchemes has the advantage that your application will work both
  132. in color as well as black and white displays.
  133. </p>
  134. <p>
  135. Views that are focusable should implement the PositionCursor to make sure that
  136. the cursor is placed in a location that makes sense. Unix terminals do not have
  137. a way of hiding the cursor, so it can be distracting to have the cursor left at
  138. the last focused view. So views should make sure that they place the cursor
  139. in a visually sensible place.
  140. </p></div>
  141. <h3 id="constructors">Constructors
  142. </h3>
  143. <a id="Terminal_Gui_View__ctor_" data-uid="Terminal.Gui.View.#ctor*"></a>
  144. <h4 id="Terminal_Gui_View__ctor_Terminal_Gui_Rect_" data-uid="Terminal.Gui.View.#ctor(Terminal.Gui.Rect)">View(Rect)</h4>
  145. <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Terminal.Gui.View.html">View</a> class with the specified frame. This is the default constructor.</p>
  146. </div>
  147. <div class="markdown level1 conceptual"></div>
  148. <h5 class="decalaration">Declaration</h5>
  149. <div class="codewrapper">
  150. <pre><code class="lang-csharp hljs">public View (Terminal.Gui.Rect frame);</code></pre>
  151. </div>
  152. <h5 class="parameters">Parameters</h5>
  153. <table class="table table-bordered table-striped table-condensed">
  154. <thead>
  155. <tr>
  156. <th>Type</th>
  157. <th>Name</th>
  158. <th>Description</th>
  159. </tr>
  160. </thead>
  161. <tbody>
  162. <tr>
  163. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  164. <td><span class="parametername">frame</span></td>
  165. <td><p>The region covered by this view.</p>
  166. </td>
  167. </tr>
  168. </tbody>
  169. </table>
  170. <h3 id="fields">Fields
  171. </h3>
  172. <h4 id="Terminal_Gui_View_Driver" data-uid="Terminal.Gui.View.Driver">Driver</h4>
  173. <div class="markdown level1 summary"><p>Points to the current driver in use by the view, it is a convenience property
  174. for simplifying the development of new views.</p>
  175. </div>
  176. <div class="markdown level1 conceptual"></div>
  177. <h5 class="decalaration">Declaration</h5>
  178. <div class="codewrapper">
  179. <pre><code class="lang-csharp hljs">public static Terminal.Gui.ConsoleDriver Driver;</code></pre>
  180. </div>
  181. <h5 class="fieldValue">Field Value</h5>
  182. <table class="table table-bordered table-striped table-condensed">
  183. <thead>
  184. <tr>
  185. <th>Type</th>
  186. <th>Description</th>
  187. </tr>
  188. </thead>
  189. <tbody>
  190. <tr>
  191. <td><a class="xref" href="Terminal.Gui.ConsoleDriver.html">ConsoleDriver</a></td>
  192. <td><p>To be added.</p>
  193. </td>
  194. </tr>
  195. </tbody>
  196. </table>
  197. <h3 id="properties">Properties
  198. </h3>
  199. <a id="Terminal_Gui_View_Bounds_" data-uid="Terminal.Gui.View.Bounds*"></a>
  200. <h4 id="Terminal_Gui_View_Bounds" data-uid="Terminal.Gui.View.Bounds">Bounds</h4>
  201. <div class="markdown level1 summary"><p>The bounds represent the View-relative rectangle used for this view. Updates to the Bounds update the Frame, and has the same side effects as updating the frame.</p>
  202. </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">public Terminal.Gui.Rect Bounds { get; set; }</code></pre>
  207. </div>
  208. <h5 class="propertyValue">Property Value</h5>
  209. <table class="table table-bordered table-striped table-condensed">
  210. <thead>
  211. <tr>
  212. <th>Type</th>
  213. <th>Description</th>
  214. </tr>
  215. </thead>
  216. <tbody>
  217. <tr>
  218. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  219. <td><p>The bounds.</p>
  220. </td>
  221. </tr>
  222. </tbody>
  223. </table>
  224. <a id="Terminal_Gui_View_ColorScheme_" data-uid="Terminal.Gui.View.ColorScheme*"></a>
  225. <h4 id="Terminal_Gui_View_ColorScheme" data-uid="Terminal.Gui.View.ColorScheme">ColorScheme</h4>
  226. <div class="markdown level1 summary"><p>The color scheme for this view, if it is not defined, it returns the parent&#39;s
  227. color scheme.</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 Terminal.Gui.ColorScheme ColorScheme { 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><p>To be added.</p>
  246. </td>
  247. </tr>
  248. </tbody>
  249. </table>
  250. <a id="Terminal_Gui_View_Focused_" data-uid="Terminal.Gui.View.Focused*"></a>
  251. <h4 id="Terminal_Gui_View_Focused" data-uid="Terminal.Gui.View.Focused">Focused</h4>
  252. <div class="markdown level1 summary"><p>Returns the currently focused view inside this view, or null if nothing is focused.</p>
  253. </div>
  254. <div class="markdown level1 conceptual"></div>
  255. <h5 class="decalaration">Declaration</h5>
  256. <div class="codewrapper">
  257. <pre><code class="lang-csharp hljs">public Terminal.Gui.View Focused { get; }</code></pre>
  258. </div>
  259. <h5 class="propertyValue">Property Value</h5>
  260. <table class="table table-bordered table-striped table-condensed">
  261. <thead>
  262. <tr>
  263. <th>Type</th>
  264. <th>Description</th>
  265. </tr>
  266. </thead>
  267. <tbody>
  268. <tr>
  269. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  270. <td><p>The focused.</p>
  271. </td>
  272. </tr>
  273. </tbody>
  274. </table>
  275. <a id="Terminal_Gui_View_Frame_" data-uid="Terminal.Gui.View.Frame*"></a>
  276. <h4 id="Terminal_Gui_View_Frame" data-uid="Terminal.Gui.View.Frame">Frame</h4>
  277. <div class="markdown level1 summary"><p>Gets or sets the frame for the view.</p>
  278. </div>
  279. <div class="markdown level1 conceptual"></div>
  280. <h5 class="decalaration">Declaration</h5>
  281. <div class="codewrapper">
  282. <pre><code class="lang-csharp hljs">public Terminal.Gui.Rect Frame { get; set; }</code></pre>
  283. </div>
  284. <h5 class="propertyValue">Property Value</h5>
  285. <table class="table table-bordered table-striped table-condensed">
  286. <thead>
  287. <tr>
  288. <th>Type</th>
  289. <th>Description</th>
  290. </tr>
  291. </thead>
  292. <tbody>
  293. <tr>
  294. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  295. <td><p>The frame.</p>
  296. </td>
  297. </tr>
  298. </tbody>
  299. </table>
  300. <h5 id="Terminal_Gui_View_Frame_remarks">Remarks</h5>
  301. <div class="markdown level1 remarks"><p>Altering the Frame of a view will trigger the redrawing of the
  302. view as well as the redrawing of the affected regions in the superview.</p>
  303. </div>
  304. <a id="Terminal_Gui_View_HasFocus_" data-uid="Terminal.Gui.View.HasFocus*"></a>
  305. <h4 id="Terminal_Gui_View_HasFocus" data-uid="Terminal.Gui.View.HasFocus">HasFocus</h4>
  306. <div class="markdown level1 summary"><p>Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.View.html">View</a> has focus.</p>
  307. </div>
  308. <div class="markdown level1 conceptual"></div>
  309. <h5 class="decalaration">Declaration</h5>
  310. <div class="codewrapper">
  311. <pre><code class="lang-csharp hljs">public override bool HasFocus { get; }</code></pre>
  312. </div>
  313. <h5 class="propertyValue">Property Value</h5>
  314. <table class="table table-bordered table-striped table-condensed">
  315. <thead>
  316. <tr>
  317. <th>Type</th>
  318. <th>Description</th>
  319. </tr>
  320. </thead>
  321. <tbody>
  322. <tr>
  323. <td><span class="xref">System.Boolean</span></td>
  324. <td><p><code>true</code> if has focus; otherwise, <code>false</code>.</p>
  325. </td>
  326. </tr>
  327. </tbody>
  328. </table>
  329. <a id="Terminal_Gui_View_Id_" data-uid="Terminal.Gui.View.Id*"></a>
  330. <h4 id="Terminal_Gui_View_Id" data-uid="Terminal.Gui.View.Id">Id</h4>
  331. <div class="markdown level1 summary"><p>Gets or sets an identifier for the view;</p>
  332. </div>
  333. <div class="markdown level1 conceptual"></div>
  334. <h5 class="decalaration">Declaration</h5>
  335. <div class="codewrapper">
  336. <pre><code class="lang-csharp hljs">public NStack.ustring Id { get; set; }</code></pre>
  337. </div>
  338. <h5 class="propertyValue">Property Value</h5>
  339. <table class="table table-bordered table-striped table-condensed">
  340. <thead>
  341. <tr>
  342. <th>Type</th>
  343. <th>Description</th>
  344. </tr>
  345. </thead>
  346. <tbody>
  347. <tr>
  348. <td><span class="xref">NStack.ustring</span></td>
  349. <td><p>The identifier.</p>
  350. </td>
  351. </tr>
  352. </tbody>
  353. </table>
  354. <a id="Terminal_Gui_View_MostFocused_" data-uid="Terminal.Gui.View.MostFocused*"></a>
  355. <h4 id="Terminal_Gui_View_MostFocused" data-uid="Terminal.Gui.View.MostFocused">MostFocused</h4>
  356. <div class="markdown level1 summary"><p>Returns the most focused view in the chain of subviews (the leaf view that has the focus).</p>
  357. </div>
  358. <div class="markdown level1 conceptual"></div>
  359. <h5 class="decalaration">Declaration</h5>
  360. <div class="codewrapper">
  361. <pre><code class="lang-csharp hljs">public Terminal.Gui.View MostFocused { get; }</code></pre>
  362. </div>
  363. <h5 class="propertyValue">Property Value</h5>
  364. <table class="table table-bordered table-striped table-condensed">
  365. <thead>
  366. <tr>
  367. <th>Type</th>
  368. <th>Description</th>
  369. </tr>
  370. </thead>
  371. <tbody>
  372. <tr>
  373. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  374. <td><p>The most focused.</p>
  375. </td>
  376. </tr>
  377. </tbody>
  378. </table>
  379. <a id="Terminal_Gui_View_Subviews_" data-uid="Terminal.Gui.View.Subviews*"></a>
  380. <h4 id="Terminal_Gui_View_Subviews" data-uid="Terminal.Gui.View.Subviews">Subviews</h4>
  381. <div class="markdown level1 summary"><p>This returns a list of the subviews contained by this view.</p>
  382. </div>
  383. <div class="markdown level1 conceptual"></div>
  384. <h5 class="decalaration">Declaration</h5>
  385. <div class="codewrapper">
  386. <pre><code class="lang-csharp hljs">public System.Collections.Generic.IList&lt;Terminal.Gui.View&gt; Subviews { get; }</code></pre>
  387. </div>
  388. <h5 class="propertyValue">Property Value</h5>
  389. <table class="table table-bordered table-striped table-condensed">
  390. <thead>
  391. <tr>
  392. <th>Type</th>
  393. <th>Description</th>
  394. </tr>
  395. </thead>
  396. <tbody>
  397. <tr>
  398. <td><span class="xref">System.Collections.Generic.IList</span>&lt;<a class="xref" href="Terminal.Gui.View.html">View</a>&gt;</td>
  399. <td><p>The subviews.</p>
  400. </td>
  401. </tr>
  402. </tbody>
  403. </table>
  404. <a id="Terminal_Gui_View_SuperView_" data-uid="Terminal.Gui.View.SuperView*"></a>
  405. <h4 id="Terminal_Gui_View_SuperView" data-uid="Terminal.Gui.View.SuperView">SuperView</h4>
  406. <div class="markdown level1 summary"><p>Returns the container for this view, or null if this view has not been added to a container.</p>
  407. </div>
  408. <div class="markdown level1 conceptual"></div>
  409. <h5 class="decalaration">Declaration</h5>
  410. <div class="codewrapper">
  411. <pre><code class="lang-csharp hljs">public Terminal.Gui.View SuperView { get; }</code></pre>
  412. </div>
  413. <h5 class="propertyValue">Property Value</h5>
  414. <table class="table table-bordered table-striped table-condensed">
  415. <thead>
  416. <tr>
  417. <th>Type</th>
  418. <th>Description</th>
  419. </tr>
  420. </thead>
  421. <tbody>
  422. <tr>
  423. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  424. <td><p>The super view.</p>
  425. </td>
  426. </tr>
  427. </tbody>
  428. </table>
  429. <a id="Terminal_Gui_View_WantMousePositionReports_" data-uid="Terminal.Gui.View.WantMousePositionReports*"></a>
  430. <h4 id="Terminal_Gui_View_WantMousePositionReports" data-uid="Terminal.Gui.View.WantMousePositionReports">WantMousePositionReports</h4>
  431. <div class="markdown level1 summary"><p>Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.View.html">View</a> want mouse position reports.</p>
  432. </div>
  433. <div class="markdown level1 conceptual"></div>
  434. <h5 class="decalaration">Declaration</h5>
  435. <div class="codewrapper">
  436. <pre><code class="lang-csharp hljs">public virtual bool WantMousePositionReports { get; set; }</code></pre>
  437. </div>
  438. <h5 class="propertyValue">Property Value</h5>
  439. <table class="table table-bordered table-striped table-condensed">
  440. <thead>
  441. <tr>
  442. <th>Type</th>
  443. <th>Description</th>
  444. </tr>
  445. </thead>
  446. <tbody>
  447. <tr>
  448. <td><span class="xref">System.Boolean</span></td>
  449. <td><p><code>true</code> if want mouse position reports; otherwise, <code>false</code>.</p>
  450. </td>
  451. </tr>
  452. </tbody>
  453. </table>
  454. <h3 id="methods">Methods
  455. </h3>
  456. <a id="Terminal_Gui_View_Add_" data-uid="Terminal.Gui.View.Add*"></a>
  457. <h4 id="Terminal_Gui_View_Add_Terminal_Gui_View_" data-uid="Terminal.Gui.View.Add(Terminal.Gui.View)">Add(View)</h4>
  458. <div class="markdown level1 summary"><p>Adds a subview to this view.</p>
  459. </div>
  460. <div class="markdown level1 conceptual"></div>
  461. <h5 class="decalaration">Declaration</h5>
  462. <div class="codewrapper">
  463. <pre><code class="lang-csharp hljs">public virtual void Add (Terminal.Gui.View view);</code></pre>
  464. </div>
  465. <h5 class="parameters">Parameters</h5>
  466. <table class="table table-bordered table-striped table-condensed">
  467. <thead>
  468. <tr>
  469. <th>Type</th>
  470. <th>Name</th>
  471. <th>Description</th>
  472. </tr>
  473. </thead>
  474. <tbody>
  475. <tr>
  476. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  477. <td><span class="parametername">view</span></td>
  478. <td><p>To be added.</p>
  479. </td>
  480. </tr>
  481. </tbody>
  482. </table>
  483. <a id="Terminal_Gui_View_Add_" data-uid="Terminal.Gui.View.Add*"></a>
  484. <h4 id="Terminal_Gui_View_Add_Terminal_Gui_View___" data-uid="Terminal.Gui.View.Add(Terminal.Gui.View[])">Add(View[])</h4>
  485. <div class="markdown level1 summary"><p>Adds the specified views to the view.</p>
  486. </div>
  487. <div class="markdown level1 conceptual"></div>
  488. <h5 class="decalaration">Declaration</h5>
  489. <div class="codewrapper">
  490. <pre><code class="lang-csharp hljs">public void Add (Terminal.Gui.View[] views);</code></pre>
  491. </div>
  492. <h5 class="parameters">Parameters</h5>
  493. <table class="table table-bordered table-striped table-condensed">
  494. <thead>
  495. <tr>
  496. <th>Type</th>
  497. <th>Name</th>
  498. <th>Description</th>
  499. </tr>
  500. </thead>
  501. <tbody>
  502. <tr>
  503. <td><a class="xref" href="Terminal.Gui.View.html">View</a>[]</td>
  504. <td><span class="parametername">views</span></td>
  505. <td><p>Array of one or more views (can be optional parameter).</p>
  506. </td>
  507. </tr>
  508. </tbody>
  509. </table>
  510. <a id="Terminal_Gui_View_AddCh_" data-uid="Terminal.Gui.View.AddCh*"></a>
  511. <h4 id="Terminal_Gui_View_AddCh_System_Int32_System_Int32_System_Int32_" data-uid="Terminal.Gui.View.AddCh(System.Int32,System.Int32,System.Int32)">AddCh(Int32, Int32, Int32)</h4>
  512. <div class="markdown level1 summary"><p>Displays the specified character in the specified column and row.</p>
  513. </div>
  514. <div class="markdown level1 conceptual"></div>
  515. <h5 class="decalaration">Declaration</h5>
  516. <div class="codewrapper">
  517. <pre><code class="lang-csharp hljs">public void AddCh (int col, int row, int ch);</code></pre>
  518. </div>
  519. <h5 class="parameters">Parameters</h5>
  520. <table class="table table-bordered table-striped table-condensed">
  521. <thead>
  522. <tr>
  523. <th>Type</th>
  524. <th>Name</th>
  525. <th>Description</th>
  526. </tr>
  527. </thead>
  528. <tbody>
  529. <tr>
  530. <td><span class="xref">System.Int32</span></td>
  531. <td><span class="parametername">col</span></td>
  532. <td><p>Col.</p>
  533. </td>
  534. </tr>
  535. <tr>
  536. <td><span class="xref">System.Int32</span></td>
  537. <td><span class="parametername">row</span></td>
  538. <td><p>Row.</p>
  539. </td>
  540. </tr>
  541. <tr>
  542. <td><span class="xref">System.Int32</span></td>
  543. <td><span class="parametername">ch</span></td>
  544. <td><p>Ch.</p>
  545. </td>
  546. </tr>
  547. </tbody>
  548. </table>
  549. <a id="Terminal_Gui_View_AddRune_" data-uid="Terminal.Gui.View.AddRune*"></a>
  550. <h4 id="Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_" data-uid="Terminal.Gui.View.AddRune(System.Int32,System.Int32,System.Rune)">AddRune(Int32, Int32, Rune)</h4>
  551. <div class="markdown level1 summary"><p>Displays the specified character in the specified column and row.</p>
  552. </div>
  553. <div class="markdown level1 conceptual"></div>
  554. <h5 class="decalaration">Declaration</h5>
  555. <div class="codewrapper">
  556. <pre><code class="lang-csharp hljs">public void AddRune (int col, int row, Rune ch);</code></pre>
  557. </div>
  558. <h5 class="parameters">Parameters</h5>
  559. <table class="table table-bordered table-striped table-condensed">
  560. <thead>
  561. <tr>
  562. <th>Type</th>
  563. <th>Name</th>
  564. <th>Description</th>
  565. </tr>
  566. </thead>
  567. <tbody>
  568. <tr>
  569. <td><span class="xref">System.Int32</span></td>
  570. <td><span class="parametername">col</span></td>
  571. <td><p>Col.</p>
  572. </td>
  573. </tr>
  574. <tr>
  575. <td><span class="xref">System.Int32</span></td>
  576. <td><span class="parametername">row</span></td>
  577. <td><p>Row.</p>
  578. </td>
  579. </tr>
  580. <tr>
  581. <td><span class="xref">System.Rune</span></td>
  582. <td><span class="parametername">ch</span></td>
  583. <td><p>Ch.</p>
  584. </td>
  585. </tr>
  586. </tbody>
  587. </table>
  588. <a id="Terminal_Gui_View_ChildNeedsDisplay_" data-uid="Terminal.Gui.View.ChildNeedsDisplay*"></a>
  589. <h4 id="Terminal_Gui_View_ChildNeedsDisplay" data-uid="Terminal.Gui.View.ChildNeedsDisplay">ChildNeedsDisplay()</h4>
  590. <div class="markdown level1 summary"><p>Flags this view for requiring the children views to be repainted.</p>
  591. </div>
  592. <div class="markdown level1 conceptual"></div>
  593. <h5 class="decalaration">Declaration</h5>
  594. <div class="codewrapper">
  595. <pre><code class="lang-csharp hljs">public void ChildNeedsDisplay ();</code></pre>
  596. </div>
  597. <a id="Terminal_Gui_View_Clear_" data-uid="Terminal.Gui.View.Clear*"></a>
  598. <h4 id="Terminal_Gui_View_Clear" data-uid="Terminal.Gui.View.Clear">Clear()</h4>
  599. <div class="markdown level1 summary"><p>Clears the view region with the current color.</p>
  600. </div>
  601. <div class="markdown level1 conceptual"></div>
  602. <h5 class="decalaration">Declaration</h5>
  603. <div class="codewrapper">
  604. <pre><code class="lang-csharp hljs">public void Clear ();</code></pre>
  605. </div>
  606. <h5 id="Terminal_Gui_View_Clear_remarks">Remarks</h5>
  607. <div class="markdown level1 remarks"><p>
  608. This clears the entire region used by this view.
  609. </p></div>
  610. <a id="Terminal_Gui_View_Clear_" data-uid="Terminal.Gui.View.Clear*"></a>
  611. <h4 id="Terminal_Gui_View_Clear_Terminal_Gui_Rect_" data-uid="Terminal.Gui.View.Clear(Terminal.Gui.Rect)">Clear(Rect)</h4>
  612. <div class="markdown level1 summary"><p>Clears the specfied rectangular region with the current color</p>
  613. </div>
  614. <div class="markdown level1 conceptual"></div>
  615. <h5 class="decalaration">Declaration</h5>
  616. <div class="codewrapper">
  617. <pre><code class="lang-csharp hljs">public void Clear (Terminal.Gui.Rect r);</code></pre>
  618. </div>
  619. <h5 class="parameters">Parameters</h5>
  620. <table class="table table-bordered table-striped table-condensed">
  621. <thead>
  622. <tr>
  623. <th>Type</th>
  624. <th>Name</th>
  625. <th>Description</th>
  626. </tr>
  627. </thead>
  628. <tbody>
  629. <tr>
  630. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  631. <td><span class="parametername">r</span></td>
  632. <td><p>To be added.</p>
  633. </td>
  634. </tr>
  635. </tbody>
  636. </table>
  637. <a id="Terminal_Gui_View_ClearNeedsDisplay_" data-uid="Terminal.Gui.View.ClearNeedsDisplay*"></a>
  638. <h4 id="Terminal_Gui_View_ClearNeedsDisplay" data-uid="Terminal.Gui.View.ClearNeedsDisplay">ClearNeedsDisplay()</h4>
  639. <div class="markdown level1 summary"><p>Removes the SetNeedsDisplay and the ChildNeedsDisplay setting on this view.</p>
  640. </div>
  641. <div class="markdown level1 conceptual"></div>
  642. <h5 class="decalaration">Declaration</h5>
  643. <div class="codewrapper">
  644. <pre><code class="lang-csharp hljs">protected void ClearNeedsDisplay ();</code></pre>
  645. </div>
  646. <a id="Terminal_Gui_View_ClipToBounds_" data-uid="Terminal.Gui.View.ClipToBounds*"></a>
  647. <h4 id="Terminal_Gui_View_ClipToBounds" data-uid="Terminal.Gui.View.ClipToBounds">ClipToBounds()</h4>
  648. <div class="markdown level1 summary"><p>Sets the Console driver&#39;s clip region to the current View&#39;s Bounds.</p>
  649. </div>
  650. <div class="markdown level1 conceptual"></div>
  651. <h5 class="decalaration">Declaration</h5>
  652. <div class="codewrapper">
  653. <pre><code class="lang-csharp hljs">public Terminal.Gui.Rect ClipToBounds ();</code></pre>
  654. </div>
  655. <h5 class="returns">Returns</h5>
  656. <table class="table table-bordered table-striped table-condensed">
  657. <thead>
  658. <tr>
  659. <th>Type</th>
  660. <th>Description</th>
  661. </tr>
  662. </thead>
  663. <tbody>
  664. <tr>
  665. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  666. <td><p>The existing driver&#39;s Clip region, which can be then set by setting the Driver.Clip property.</p>
  667. </td>
  668. </tr>
  669. </tbody>
  670. </table>
  671. <a id="Terminal_Gui_View_DrawFrame_" data-uid="Terminal.Gui.View.DrawFrame*"></a>
  672. <h4 id="Terminal_Gui_View_DrawFrame_Terminal_Gui_Rect_System_Boolean_" data-uid="Terminal.Gui.View.DrawFrame(Terminal.Gui.Rect,System.Boolean)">DrawFrame(Rect, Boolean)</h4>
  673. <div class="markdown level1 summary"><p>Draws a frame in the current view, clipped by the boundary of this view</p>
  674. </div>
  675. <div class="markdown level1 conceptual"></div>
  676. <h5 class="decalaration">Declaration</h5>
  677. <div class="codewrapper">
  678. <pre><code class="lang-csharp hljs">public void DrawFrame (Terminal.Gui.Rect rect, bool fill = false);</code></pre>
  679. </div>
  680. <h5 class="parameters">Parameters</h5>
  681. <table class="table table-bordered table-striped table-condensed">
  682. <thead>
  683. <tr>
  684. <th>Type</th>
  685. <th>Name</th>
  686. <th>Description</th>
  687. </tr>
  688. </thead>
  689. <tbody>
  690. <tr>
  691. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  692. <td><span class="parametername">rect</span></td>
  693. <td><p>Rectangular region for the frame to be drawn.</p>
  694. </td>
  695. </tr>
  696. <tr>
  697. <td><span class="xref">System.Boolean</span></td>
  698. <td><span class="parametername">fill</span></td>
  699. <td><p>If set to <code>true</code> it fill will the contents.</p>
  700. </td>
  701. </tr>
  702. </tbody>
  703. </table>
  704. <a id="Terminal_Gui_View_DrawFrame_" data-uid="Terminal.Gui.View.DrawFrame*"></a>
  705. <h4 id="Terminal_Gui_View_DrawFrame_Terminal_Gui_Rect_System_Int32_System_Boolean_" data-uid="Terminal.Gui.View.DrawFrame(Terminal.Gui.Rect,System.Int32,System.Boolean)">DrawFrame(Rect, Int32, Boolean)</h4>
  706. <div class="markdown level1 summary"><p>Draws a frame in the current view, clipped by the boundary of this view</p>
  707. </div>
  708. <div class="markdown level1 conceptual"></div>
  709. <h5 class="decalaration">Declaration</h5>
  710. <div class="codewrapper">
  711. <pre><code class="lang-csharp hljs">public void DrawFrame (Terminal.Gui.Rect rect, int padding = 0, bool fill = false);</code></pre>
  712. </div>
  713. <h5 class="parameters">Parameters</h5>
  714. <table class="table table-bordered table-striped table-condensed">
  715. <thead>
  716. <tr>
  717. <th>Type</th>
  718. <th>Name</th>
  719. <th>Description</th>
  720. </tr>
  721. </thead>
  722. <tbody>
  723. <tr>
  724. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  725. <td><span class="parametername">rect</span></td>
  726. <td><p>Rectangular region for the frame to be drawn.</p>
  727. </td>
  728. </tr>
  729. <tr>
  730. <td><span class="xref">System.Int32</span></td>
  731. <td><span class="parametername">padding</span></td>
  732. <td><p>The padding to add to the drawn frame.</p>
  733. </td>
  734. </tr>
  735. <tr>
  736. <td><span class="xref">System.Boolean</span></td>
  737. <td><span class="parametername">fill</span></td>
  738. <td><p>If set to <code>true</code> it fill will the contents.</p>
  739. </td>
  740. </tr>
  741. </tbody>
  742. </table>
  743. <a id="Terminal_Gui_View_DrawHotString_" data-uid="Terminal.Gui.View.DrawHotString*"></a>
  744. <h4 id="Terminal_Gui_View_DrawHotString_NStack_ustring_System_Boolean_Terminal_Gui_ColorScheme_" data-uid="Terminal.Gui.View.DrawHotString(NStack.ustring,System.Boolean,Terminal.Gui.ColorScheme)">DrawHotString(ustring, Boolean, ColorScheme)</h4>
  745. <div class="markdown level1 summary"><p>Utility function to draw strings that contains a hotkey using a colorscheme and the &quot;focused&quot; state.</p>
  746. </div>
  747. <div class="markdown level1 conceptual"></div>
  748. <h5 class="decalaration">Declaration</h5>
  749. <div class="codewrapper">
  750. <pre><code class="lang-csharp hljs">public void DrawHotString (NStack.ustring text, bool focused, Terminal.Gui.ColorScheme scheme);</code></pre>
  751. </div>
  752. <h5 class="parameters">Parameters</h5>
  753. <table class="table table-bordered table-striped table-condensed">
  754. <thead>
  755. <tr>
  756. <th>Type</th>
  757. <th>Name</th>
  758. <th>Description</th>
  759. </tr>
  760. </thead>
  761. <tbody>
  762. <tr>
  763. <td><span class="xref">NStack.ustring</span></td>
  764. <td><span class="parametername">text</span></td>
  765. <td><p>String to display, the underscoore before a letter flags the next letter as the hotkey.</p>
  766. </td>
  767. </tr>
  768. <tr>
  769. <td><span class="xref">System.Boolean</span></td>
  770. <td><span class="parametername">focused</span></td>
  771. <td><p>If set to <code>true</code> this uses the focused colors from the color scheme, otherwise the regular ones.</p>
  772. </td>
  773. </tr>
  774. <tr>
  775. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  776. <td><span class="parametername">scheme</span></td>
  777. <td><p>The color scheme to use.</p>
  778. </td>
  779. </tr>
  780. </tbody>
  781. </table>
  782. <a id="Terminal_Gui_View_DrawHotString_" data-uid="Terminal.Gui.View.DrawHotString*"></a>
  783. <h4 id="Terminal_Gui_View_DrawHotString_NStack_ustring_Terminal_Gui_Attribute_Terminal_Gui_Attribute_" data-uid="Terminal.Gui.View.DrawHotString(NStack.ustring,Terminal.Gui.Attribute,Terminal.Gui.Attribute)">DrawHotString(ustring, Attribute, Attribute)</h4>
  784. <div class="markdown level1 summary"><p>Utility function to draw strings that contain a hotkey</p>
  785. </div>
  786. <div class="markdown level1 conceptual"></div>
  787. <h5 class="decalaration">Declaration</h5>
  788. <div class="codewrapper">
  789. <pre><code class="lang-csharp hljs">public void DrawHotString (NStack.ustring text, Terminal.Gui.Attribute hotColor, Terminal.Gui.Attribute normalColor);</code></pre>
  790. </div>
  791. <h5 class="parameters">Parameters</h5>
  792. <table class="table table-bordered table-striped table-condensed">
  793. <thead>
  794. <tr>
  795. <th>Type</th>
  796. <th>Name</th>
  797. <th>Description</th>
  798. </tr>
  799. </thead>
  800. <tbody>
  801. <tr>
  802. <td><span class="xref">NStack.ustring</span></td>
  803. <td><span class="parametername">text</span></td>
  804. <td><p>String to display, the underscoore before a letter flags the next letter as the hotkey.</p>
  805. </td>
  806. </tr>
  807. <tr>
  808. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  809. <td><span class="parametername">hotColor</span></td>
  810. <td><p>Hot color.</p>
  811. </td>
  812. </tr>
  813. <tr>
  814. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  815. <td><span class="parametername">normalColor</span></td>
  816. <td><p>Normal color.</p>
  817. </td>
  818. </tr>
  819. </tbody>
  820. </table>
  821. <a id="Terminal_Gui_View_DrawHotString_" data-uid="Terminal.Gui.View.DrawHotString*"></a>
  822. <h4 id="Terminal_Gui_View_DrawHotString_System_String_System_Boolean_Terminal_Gui_ColorScheme_" data-uid="Terminal.Gui.View.DrawHotString(System.String,System.Boolean,Terminal.Gui.ColorScheme)">DrawHotString(String, Boolean, ColorScheme)</h4>
  823. <div class="markdown level1 summary"><p>Utility function to draw strings that contains a hotkey using a colorscheme and the &quot;focused&quot; state.</p>
  824. </div>
  825. <div class="markdown level1 conceptual"></div>
  826. <h5 class="decalaration">Declaration</h5>
  827. <div class="codewrapper">
  828. <pre><code class="lang-csharp hljs">public void DrawHotString (string text, bool focused, Terminal.Gui.ColorScheme scheme);</code></pre>
  829. </div>
  830. <h5 class="parameters">Parameters</h5>
  831. <table class="table table-bordered table-striped table-condensed">
  832. <thead>
  833. <tr>
  834. <th>Type</th>
  835. <th>Name</th>
  836. <th>Description</th>
  837. </tr>
  838. </thead>
  839. <tbody>
  840. <tr>
  841. <td><span class="xref">System.String</span></td>
  842. <td><span class="parametername">text</span></td>
  843. <td><p>String to display, the underscoore before a letter flags the next letter as the hotkey.</p>
  844. </td>
  845. </tr>
  846. <tr>
  847. <td><span class="xref">System.Boolean</span></td>
  848. <td><span class="parametername">focused</span></td>
  849. <td><p>If set to <code>true</code> this uses the focused colors from the color scheme, otherwise the regular ones.</p>
  850. </td>
  851. </tr>
  852. <tr>
  853. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  854. <td><span class="parametername">scheme</span></td>
  855. <td><p>The color scheme to use.</p>
  856. </td>
  857. </tr>
  858. </tbody>
  859. </table>
  860. <a id="Terminal_Gui_View_DrawHotString_" data-uid="Terminal.Gui.View.DrawHotString*"></a>
  861. <h4 id="Terminal_Gui_View_DrawHotString_System_String_Terminal_Gui_Attribute_Terminal_Gui_Attribute_" data-uid="Terminal.Gui.View.DrawHotString(System.String,Terminal.Gui.Attribute,Terminal.Gui.Attribute)">DrawHotString(String, Attribute, Attribute)</h4>
  862. <div class="markdown level1 summary"><p>Utility function to draw strings that contain a hotkey</p>
  863. </div>
  864. <div class="markdown level1 conceptual"></div>
  865. <h5 class="decalaration">Declaration</h5>
  866. <div class="codewrapper">
  867. <pre><code class="lang-csharp hljs">public void DrawHotString (string text, Terminal.Gui.Attribute hotColor, Terminal.Gui.Attribute normalColor);</code></pre>
  868. </div>
  869. <h5 class="parameters">Parameters</h5>
  870. <table class="table table-bordered table-striped table-condensed">
  871. <thead>
  872. <tr>
  873. <th>Type</th>
  874. <th>Name</th>
  875. <th>Description</th>
  876. </tr>
  877. </thead>
  878. <tbody>
  879. <tr>
  880. <td><span class="xref">System.String</span></td>
  881. <td><span class="parametername">text</span></td>
  882. <td><p>String to display, the underscoore before a letter flags the next letter as the hotkey.</p>
  883. </td>
  884. </tr>
  885. <tr>
  886. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  887. <td><span class="parametername">hotColor</span></td>
  888. <td><p>Hot color.</p>
  889. </td>
  890. </tr>
  891. <tr>
  892. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  893. <td><span class="parametername">normalColor</span></td>
  894. <td><p>Normal color.</p>
  895. </td>
  896. </tr>
  897. </tbody>
  898. </table>
  899. <a id="Terminal_Gui_View_EnsureFocus_" data-uid="Terminal.Gui.View.EnsureFocus*"></a>
  900. <h4 id="Terminal_Gui_View_EnsureFocus" data-uid="Terminal.Gui.View.EnsureFocus">EnsureFocus()</h4>
  901. <div class="markdown level1 summary"><p>Finds the first view in the hierarchy that wants to get the focus if nothing is currently focused, otherwise, it does nothing.</p>
  902. </div>
  903. <div class="markdown level1 conceptual"></div>
  904. <h5 class="decalaration">Declaration</h5>
  905. <div class="codewrapper">
  906. <pre><code class="lang-csharp hljs">public void EnsureFocus ();</code></pre>
  907. </div>
  908. <a id="Terminal_Gui_View_FocusFirst_" data-uid="Terminal.Gui.View.FocusFirst*"></a>
  909. <h4 id="Terminal_Gui_View_FocusFirst" data-uid="Terminal.Gui.View.FocusFirst">FocusFirst()</h4>
  910. <div class="markdown level1 summary"><p>Focuses the first focusable subview if one exists.</p>
  911. </div>
  912. <div class="markdown level1 conceptual"></div>
  913. <h5 class="decalaration">Declaration</h5>
  914. <div class="codewrapper">
  915. <pre><code class="lang-csharp hljs">public void FocusFirst ();</code></pre>
  916. </div>
  917. <a id="Terminal_Gui_View_FocusLast_" data-uid="Terminal.Gui.View.FocusLast*"></a>
  918. <h4 id="Terminal_Gui_View_FocusLast" data-uid="Terminal.Gui.View.FocusLast">FocusLast()</h4>
  919. <div class="markdown level1 summary"><p>Focuses the last focusable subview if one exists.</p>
  920. </div>
  921. <div class="markdown level1 conceptual"></div>
  922. <h5 class="decalaration">Declaration</h5>
  923. <div class="codewrapper">
  924. <pre><code class="lang-csharp hljs">public void FocusLast ();</code></pre>
  925. </div>
  926. <a id="Terminal_Gui_View_FocusNext_" data-uid="Terminal.Gui.View.FocusNext*"></a>
  927. <h4 id="Terminal_Gui_View_FocusNext" data-uid="Terminal.Gui.View.FocusNext">FocusNext()</h4>
  928. <div class="markdown level1 summary"><p>Focuses the next view.</p>
  929. </div>
  930. <div class="markdown level1 conceptual"></div>
  931. <h5 class="decalaration">Declaration</h5>
  932. <div class="codewrapper">
  933. <pre><code class="lang-csharp hljs">public bool FocusNext ();</code></pre>
  934. </div>
  935. <h5 class="returns">Returns</h5>
  936. <table class="table table-bordered table-striped table-condensed">
  937. <thead>
  938. <tr>
  939. <th>Type</th>
  940. <th>Description</th>
  941. </tr>
  942. </thead>
  943. <tbody>
  944. <tr>
  945. <td><span class="xref">System.Boolean</span></td>
  946. <td><p><code>true</code>, if next was focused, <code>false</code> otherwise.</p>
  947. </td>
  948. </tr>
  949. </tbody>
  950. </table>
  951. <a id="Terminal_Gui_View_FocusPrev_" data-uid="Terminal.Gui.View.FocusPrev*"></a>
  952. <h4 id="Terminal_Gui_View_FocusPrev" data-uid="Terminal.Gui.View.FocusPrev">FocusPrev()</h4>
  953. <div class="markdown level1 summary"><p>Focuses the previous view.</p>
  954. </div>
  955. <div class="markdown level1 conceptual"></div>
  956. <h5 class="decalaration">Declaration</h5>
  957. <div class="codewrapper">
  958. <pre><code class="lang-csharp hljs">public bool FocusPrev ();</code></pre>
  959. </div>
  960. <h5 class="returns">Returns</h5>
  961. <table class="table table-bordered table-striped table-condensed">
  962. <thead>
  963. <tr>
  964. <th>Type</th>
  965. <th>Description</th>
  966. </tr>
  967. </thead>
  968. <tbody>
  969. <tr>
  970. <td><span class="xref">System.Boolean</span></td>
  971. <td><p><code>true</code>, if previous was focused, <code>false</code> otherwise.</p>
  972. </td>
  973. </tr>
  974. </tbody>
  975. </table>
  976. <a id="Terminal_Gui_View_GetEnumerator_" data-uid="Terminal.Gui.View.GetEnumerator*"></a>
  977. <h4 id="Terminal_Gui_View_GetEnumerator" data-uid="Terminal.Gui.View.GetEnumerator">GetEnumerator()</h4>
  978. <div class="markdown level1 summary"><p>Gets an enumerator that enumerates the subviews in this view.</p>
  979. </div>
  980. <div class="markdown level1 conceptual"></div>
  981. <h5 class="decalaration">Declaration</h5>
  982. <div class="codewrapper">
  983. <pre><code class="lang-csharp hljs">[System.Runtime.CompilerServices.IteratorStateMachine(typeof(Terminal.Gui.View/&lt;GetEnumerator&gt;d__23))]
  984. public System.Collections.IEnumerator GetEnumerator ();</code></pre>
  985. </div>
  986. <h5 class="returns">Returns</h5>
  987. <table class="table table-bordered table-striped table-condensed">
  988. <thead>
  989. <tr>
  990. <th>Type</th>
  991. <th>Description</th>
  992. </tr>
  993. </thead>
  994. <tbody>
  995. <tr>
  996. <td><span class="xref">System.Collections.IEnumerator</span></td>
  997. <td><p>The enumerator.</p>
  998. </td>
  999. </tr>
  1000. </tbody>
  1001. </table>
  1002. <a id="Terminal_Gui_View_LayoutSubviews_" data-uid="Terminal.Gui.View.LayoutSubviews*"></a>
  1003. <h4 id="Terminal_Gui_View_LayoutSubviews" data-uid="Terminal.Gui.View.LayoutSubviews">LayoutSubviews()</h4>
  1004. <div class="markdown level1 summary"><p>This virtual method is invoked when a view starts executing or
  1005. when the dimensions of the view have changed, for example in
  1006. response to the container view or terminal resizing.</p>
  1007. </div>
  1008. <div class="markdown level1 conceptual"></div>
  1009. <h5 class="decalaration">Declaration</h5>
  1010. <div class="codewrapper">
  1011. <pre><code class="lang-csharp hljs">public virtual void LayoutSubviews ();</code></pre>
  1012. </div>
  1013. <a id="Terminal_Gui_View_Move_" data-uid="Terminal.Gui.View.Move*"></a>
  1014. <h4 id="Terminal_Gui_View_Move_System_Int32_System_Int32_" data-uid="Terminal.Gui.View.Move(System.Int32,System.Int32)">Move(Int32, Int32)</h4>
  1015. <div class="markdown level1 summary"><p>This moves the cursor to the specified column and row in the view.</p>
  1016. </div>
  1017. <div class="markdown level1 conceptual"></div>
  1018. <h5 class="decalaration">Declaration</h5>
  1019. <div class="codewrapper">
  1020. <pre><code class="lang-csharp hljs">public void Move (int col, int row);</code></pre>
  1021. </div>
  1022. <h5 class="parameters">Parameters</h5>
  1023. <table class="table table-bordered table-striped table-condensed">
  1024. <thead>
  1025. <tr>
  1026. <th>Type</th>
  1027. <th>Name</th>
  1028. <th>Description</th>
  1029. </tr>
  1030. </thead>
  1031. <tbody>
  1032. <tr>
  1033. <td><span class="xref">System.Int32</span></td>
  1034. <td><span class="parametername">col</span></td>
  1035. <td><p>Col.</p>
  1036. </td>
  1037. </tr>
  1038. <tr>
  1039. <td><span class="xref">System.Int32</span></td>
  1040. <td><span class="parametername">row</span></td>
  1041. <td><p>Row.</p>
  1042. </td>
  1043. </tr>
  1044. </tbody>
  1045. </table>
  1046. <a id="Terminal_Gui_View_PositionCursor_" data-uid="Terminal.Gui.View.PositionCursor*"></a>
  1047. <h4 id="Terminal_Gui_View_PositionCursor" data-uid="Terminal.Gui.View.PositionCursor">PositionCursor()</h4>
  1048. <div class="markdown level1 summary"><p>Positions the cursor in the right position based on the currently focused view in the chain.</p>
  1049. </div>
  1050. <div class="markdown level1 conceptual"></div>
  1051. <h5 class="decalaration">Declaration</h5>
  1052. <div class="codewrapper">
  1053. <pre><code class="lang-csharp hljs">public virtual void PositionCursor ();</code></pre>
  1054. </div>
  1055. <a id="Terminal_Gui_View_ProcessColdKey_" data-uid="Terminal.Gui.View.ProcessColdKey*"></a>
  1056. <h4 id="Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.View.ProcessColdKey(Terminal.Gui.KeyEvent)">ProcessColdKey(KeyEvent)</h4>
  1057. <div class="markdown level1 summary"></div>
  1058. <div class="markdown level1 conceptual"></div>
  1059. <h5 class="decalaration">Declaration</h5>
  1060. <div class="codewrapper">
  1061. <pre><code class="lang-csharp hljs">public override bool ProcessColdKey (Terminal.Gui.KeyEvent keyEvent);</code></pre>
  1062. </div>
  1063. <h5 class="parameters">Parameters</h5>
  1064. <table class="table table-bordered table-striped table-condensed">
  1065. <thead>
  1066. <tr>
  1067. <th>Type</th>
  1068. <th>Name</th>
  1069. <th>Description</th>
  1070. </tr>
  1071. </thead>
  1072. <tbody>
  1073. <tr>
  1074. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  1075. <td><span class="parametername">kb</span></td>
  1076. <td><p>To be added.</p>
  1077. </td>
  1078. </tr>
  1079. </tbody>
  1080. </table>
  1081. <h5 class="returns">Returns</h5>
  1082. <table class="table table-bordered table-striped table-condensed">
  1083. <thead>
  1084. <tr>
  1085. <th>Type</th>
  1086. <th>Description</th>
  1087. </tr>
  1088. </thead>
  1089. <tbody>
  1090. <tr>
  1091. <td><span class="xref">System.Boolean</span></td>
  1092. <td><p>To be added.</p>
  1093. </td>
  1094. </tr>
  1095. </tbody>
  1096. </table>
  1097. <a id="Terminal_Gui_View_ProcessHotKey_" data-uid="Terminal.Gui.View.ProcessHotKey*"></a>
  1098. <h4 id="Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.View.ProcessHotKey(Terminal.Gui.KeyEvent)">ProcessHotKey(KeyEvent)</h4>
  1099. <div class="markdown level1 summary"></div>
  1100. <div class="markdown level1 conceptual"></div>
  1101. <h5 class="decalaration">Declaration</h5>
  1102. <div class="codewrapper">
  1103. <pre><code class="lang-csharp hljs">public override bool ProcessHotKey (Terminal.Gui.KeyEvent keyEvent);</code></pre>
  1104. </div>
  1105. <h5 class="parameters">Parameters</h5>
  1106. <table class="table table-bordered table-striped table-condensed">
  1107. <thead>
  1108. <tr>
  1109. <th>Type</th>
  1110. <th>Name</th>
  1111. <th>Description</th>
  1112. </tr>
  1113. </thead>
  1114. <tbody>
  1115. <tr>
  1116. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  1117. <td><span class="parametername">kb</span></td>
  1118. <td><p>To be added.</p>
  1119. </td>
  1120. </tr>
  1121. </tbody>
  1122. </table>
  1123. <h5 class="returns">Returns</h5>
  1124. <table class="table table-bordered table-striped table-condensed">
  1125. <thead>
  1126. <tr>
  1127. <th>Type</th>
  1128. <th>Description</th>
  1129. </tr>
  1130. </thead>
  1131. <tbody>
  1132. <tr>
  1133. <td><span class="xref">System.Boolean</span></td>
  1134. <td><p>To be added.</p>
  1135. </td>
  1136. </tr>
  1137. </tbody>
  1138. </table>
  1139. <a id="Terminal_Gui_View_ProcessKey_" data-uid="Terminal.Gui.View.ProcessKey*"></a>
  1140. <h4 id="Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.View.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  1141. <div class="markdown level1 summary"></div>
  1142. <div class="markdown level1 conceptual"></div>
  1143. <h5 class="decalaration">Declaration</h5>
  1144. <div class="codewrapper">
  1145. <pre><code class="lang-csharp hljs">public override bool ProcessKey (Terminal.Gui.KeyEvent keyEvent);</code></pre>
  1146. </div>
  1147. <h5 class="parameters">Parameters</h5>
  1148. <table class="table table-bordered table-striped table-condensed">
  1149. <thead>
  1150. <tr>
  1151. <th>Type</th>
  1152. <th>Name</th>
  1153. <th>Description</th>
  1154. </tr>
  1155. </thead>
  1156. <tbody>
  1157. <tr>
  1158. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  1159. <td><span class="parametername">kb</span></td>
  1160. <td><p>To be added.</p>
  1161. </td>
  1162. </tr>
  1163. </tbody>
  1164. </table>
  1165. <h5 class="returns">Returns</h5>
  1166. <table class="table table-bordered table-striped table-condensed">
  1167. <thead>
  1168. <tr>
  1169. <th>Type</th>
  1170. <th>Description</th>
  1171. </tr>
  1172. </thead>
  1173. <tbody>
  1174. <tr>
  1175. <td><span class="xref">System.Boolean</span></td>
  1176. <td><p>To be added.</p>
  1177. </td>
  1178. </tr>
  1179. </tbody>
  1180. </table>
  1181. <a id="Terminal_Gui_View_Redraw_" data-uid="Terminal.Gui.View.Redraw*"></a>
  1182. <h4 id="Terminal_Gui_View_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.View.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  1183. <div class="markdown level1 summary"><p>Performs a redraw of this view and its subviews, only redraws the views that have been flagged for a re-display.</p>
  1184. </div>
  1185. <div class="markdown level1 conceptual"></div>
  1186. <h5 class="decalaration">Declaration</h5>
  1187. <div class="codewrapper">
  1188. <pre><code class="lang-csharp hljs">public virtual void Redraw (Terminal.Gui.Rect region);</code></pre>
  1189. </div>
  1190. <h5 class="parameters">Parameters</h5>
  1191. <table class="table table-bordered table-striped table-condensed">
  1192. <thead>
  1193. <tr>
  1194. <th>Type</th>
  1195. <th>Name</th>
  1196. <th>Description</th>
  1197. </tr>
  1198. </thead>
  1199. <tbody>
  1200. <tr>
  1201. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1202. <td><span class="parametername">region</span></td>
  1203. <td><p>The region to redraw, this is relative to the view itself.</p>
  1204. </td>
  1205. </tr>
  1206. </tbody>
  1207. </table>
  1208. <h5 id="Terminal_Gui_View_Redraw_Terminal_Gui_Rect__remarks">Remarks</h5>
  1209. <div class="markdown level1 remarks"><p>
  1210. Views should set the color that they want to use on entry, as otherwise this will inherit
  1211. the last color that was set globaly on the driver.
  1212. </p></div>
  1213. <a id="Terminal_Gui_View_Remove_" data-uid="Terminal.Gui.View.Remove*"></a>
  1214. <h4 id="Terminal_Gui_View_Remove_Terminal_Gui_View_" data-uid="Terminal.Gui.View.Remove(Terminal.Gui.View)">Remove(View)</h4>
  1215. <div class="markdown level1 summary"><p>Removes a widget from this container.</p>
  1216. </div>
  1217. <div class="markdown level1 conceptual"></div>
  1218. <h5 class="decalaration">Declaration</h5>
  1219. <div class="codewrapper">
  1220. <pre><code class="lang-csharp hljs">public virtual void Remove (Terminal.Gui.View view);</code></pre>
  1221. </div>
  1222. <h5 class="parameters">Parameters</h5>
  1223. <table class="table table-bordered table-striped table-condensed">
  1224. <thead>
  1225. <tr>
  1226. <th>Type</th>
  1227. <th>Name</th>
  1228. <th>Description</th>
  1229. </tr>
  1230. </thead>
  1231. <tbody>
  1232. <tr>
  1233. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  1234. <td><span class="parametername">view</span></td>
  1235. <td><p>To be added.</p>
  1236. </td>
  1237. </tr>
  1238. </tbody>
  1239. </table>
  1240. <a id="Terminal_Gui_View_RemoveAll_" data-uid="Terminal.Gui.View.RemoveAll*"></a>
  1241. <h4 id="Terminal_Gui_View_RemoveAll" data-uid="Terminal.Gui.View.RemoveAll">RemoveAll()</h4>
  1242. <div class="markdown level1 summary"><p>Removes all the widgets from this container.</p>
  1243. </div>
  1244. <div class="markdown level1 conceptual"></div>
  1245. <h5 class="decalaration">Declaration</h5>
  1246. <div class="codewrapper">
  1247. <pre><code class="lang-csharp hljs">public virtual void RemoveAll ();</code></pre>
  1248. </div>
  1249. <a id="Terminal_Gui_View_ScreenToView_" data-uid="Terminal.Gui.View.ScreenToView*"></a>
  1250. <h4 id="Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_" data-uid="Terminal.Gui.View.ScreenToView(System.Int32,System.Int32)">ScreenToView(Int32, Int32)</h4>
  1251. <div class="markdown level1 summary"><p>Converts a point from screen coordinates into the view coordinate space.</p>
  1252. </div>
  1253. <div class="markdown level1 conceptual"></div>
  1254. <h5 class="decalaration">Declaration</h5>
  1255. <div class="codewrapper">
  1256. <pre><code class="lang-csharp hljs">public Terminal.Gui.Point ScreenToView (int x, int y);</code></pre>
  1257. </div>
  1258. <h5 class="parameters">Parameters</h5>
  1259. <table class="table table-bordered table-striped table-condensed">
  1260. <thead>
  1261. <tr>
  1262. <th>Type</th>
  1263. <th>Name</th>
  1264. <th>Description</th>
  1265. </tr>
  1266. </thead>
  1267. <tbody>
  1268. <tr>
  1269. <td><span class="xref">System.Int32</span></td>
  1270. <td><span class="parametername">x</span></td>
  1271. <td><p>X screen-coordinate point.</p>
  1272. </td>
  1273. </tr>
  1274. <tr>
  1275. <td><span class="xref">System.Int32</span></td>
  1276. <td><span class="parametername">y</span></td>
  1277. <td><p>Y screen-coordinate point.</p>
  1278. </td>
  1279. </tr>
  1280. </tbody>
  1281. </table>
  1282. <h5 class="returns">Returns</h5>
  1283. <table class="table table-bordered table-striped table-condensed">
  1284. <thead>
  1285. <tr>
  1286. <th>Type</th>
  1287. <th>Description</th>
  1288. </tr>
  1289. </thead>
  1290. <tbody>
  1291. <tr>
  1292. <td><a class="xref" href="Terminal.Gui.Point.html">Point</a></td>
  1293. <td><p>The mapped point.</p>
  1294. </td>
  1295. </tr>
  1296. </tbody>
  1297. </table>
  1298. <a id="Terminal_Gui_View_SetClip_" data-uid="Terminal.Gui.View.SetClip*"></a>
  1299. <h4 id="Terminal_Gui_View_SetClip_Terminal_Gui_Rect_" data-uid="Terminal.Gui.View.SetClip(Terminal.Gui.Rect)">SetClip(Rect)</h4>
  1300. <div class="markdown level1 summary"><p>Sets the clipping region to the specified region, the region is view-relative</p>
  1301. </div>
  1302. <div class="markdown level1 conceptual"></div>
  1303. <h5 class="decalaration">Declaration</h5>
  1304. <div class="codewrapper">
  1305. <pre><code class="lang-csharp hljs">public Terminal.Gui.Rect SetClip (Terminal.Gui.Rect rect);</code></pre>
  1306. </div>
  1307. <h5 class="parameters">Parameters</h5>
  1308. <table class="table table-bordered table-striped table-condensed">
  1309. <thead>
  1310. <tr>
  1311. <th>Type</th>
  1312. <th>Name</th>
  1313. <th>Description</th>
  1314. </tr>
  1315. </thead>
  1316. <tbody>
  1317. <tr>
  1318. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1319. <td><span class="parametername">rect</span></td>
  1320. <td><p>Rectangle region to clip into, the region is view-relative.</p>
  1321. </td>
  1322. </tr>
  1323. </tbody>
  1324. </table>
  1325. <h5 class="returns">Returns</h5>
  1326. <table class="table table-bordered table-striped table-condensed">
  1327. <thead>
  1328. <tr>
  1329. <th>Type</th>
  1330. <th>Description</th>
  1331. </tr>
  1332. </thead>
  1333. <tbody>
  1334. <tr>
  1335. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1336. <td><p>The previous clip region.</p>
  1337. </td>
  1338. </tr>
  1339. </tbody>
  1340. </table>
  1341. <a id="Terminal_Gui_View_SetFocus_" data-uid="Terminal.Gui.View.SetFocus*"></a>
  1342. <h4 id="Terminal_Gui_View_SetFocus_Terminal_Gui_View_" data-uid="Terminal.Gui.View.SetFocus(Terminal.Gui.View)">SetFocus(View)</h4>
  1343. <div class="markdown level1 summary"><p>Focuses the specified sub-view.</p>
  1344. </div>
  1345. <div class="markdown level1 conceptual"></div>
  1346. <h5 class="decalaration">Declaration</h5>
  1347. <div class="codewrapper">
  1348. <pre><code class="lang-csharp hljs">public void SetFocus (Terminal.Gui.View view);</code></pre>
  1349. </div>
  1350. <h5 class="parameters">Parameters</h5>
  1351. <table class="table table-bordered table-striped table-condensed">
  1352. <thead>
  1353. <tr>
  1354. <th>Type</th>
  1355. <th>Name</th>
  1356. <th>Description</th>
  1357. </tr>
  1358. </thead>
  1359. <tbody>
  1360. <tr>
  1361. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  1362. <td><span class="parametername">view</span></td>
  1363. <td><p>View.</p>
  1364. </td>
  1365. </tr>
  1366. </tbody>
  1367. </table>
  1368. <a id="Terminal_Gui_View_SetNeedsDisplay_" data-uid="Terminal.Gui.View.SetNeedsDisplay*"></a>
  1369. <h4 id="Terminal_Gui_View_SetNeedsDisplay" data-uid="Terminal.Gui.View.SetNeedsDisplay">SetNeedsDisplay()</h4>
  1370. <div class="markdown level1 summary"><p>Invoke to flag that this view needs to be redisplayed, by any code
  1371. that alters the state of the view.</p>
  1372. </div>
  1373. <div class="markdown level1 conceptual"></div>
  1374. <h5 class="decalaration">Declaration</h5>
  1375. <div class="codewrapper">
  1376. <pre><code class="lang-csharp hljs">public void SetNeedsDisplay ();</code></pre>
  1377. </div>
  1378. <a id="Terminal_Gui_View_SetNeedsDisplay_" data-uid="Terminal.Gui.View.SetNeedsDisplay*"></a>
  1379. <h4 id="Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_" data-uid="Terminal.Gui.View.SetNeedsDisplay(Terminal.Gui.Rect)">SetNeedsDisplay(Rect)</h4>
  1380. <div class="markdown level1 summary"><p>Flags the specified rectangle region on this view as needing to be repainted.</p>
  1381. </div>
  1382. <div class="markdown level1 conceptual"></div>
  1383. <h5 class="decalaration">Declaration</h5>
  1384. <div class="codewrapper">
  1385. <pre><code class="lang-csharp hljs">public void SetNeedsDisplay (Terminal.Gui.Rect region);</code></pre>
  1386. </div>
  1387. <h5 class="parameters">Parameters</h5>
  1388. <table class="table table-bordered table-striped table-condensed">
  1389. <thead>
  1390. <tr>
  1391. <th>Type</th>
  1392. <th>Name</th>
  1393. <th>Description</th>
  1394. </tr>
  1395. </thead>
  1396. <tbody>
  1397. <tr>
  1398. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1399. <td><span class="parametername">region</span></td>
  1400. <td><p>The region that must be flagged for repaint.</p>
  1401. </td>
  1402. </tr>
  1403. </tbody>
  1404. </table>
  1405. <a id="Terminal_Gui_View_ToString_" data-uid="Terminal.Gui.View.ToString*"></a>
  1406. <h4 id="Terminal_Gui_View_ToString" data-uid="Terminal.Gui.View.ToString">ToString()</h4>
  1407. <div class="markdown level1 summary"><p>Returns a <span class="xref">System.String</span> that represents the current <a class="xref" href="Terminal.Gui.View.html">View</a>.</p>
  1408. </div>
  1409. <div class="markdown level1 conceptual"></div>
  1410. <h5 class="decalaration">Declaration</h5>
  1411. <div class="codewrapper">
  1412. <pre><code class="lang-csharp hljs">public override string ToString ();</code></pre>
  1413. </div>
  1414. <h5 class="returns">Returns</h5>
  1415. <table class="table table-bordered table-striped table-condensed">
  1416. <thead>
  1417. <tr>
  1418. <th>Type</th>
  1419. <th>Description</th>
  1420. </tr>
  1421. </thead>
  1422. <tbody>
  1423. <tr>
  1424. <td><span class="xref">System.String</span></td>
  1425. <td><p>A <span class="xref">System.String</span> that represents the current <a class="xref" href="Terminal.Gui.View.html">View</a>.</p>
  1426. </td>
  1427. </tr>
  1428. </tbody>
  1429. </table>
  1430. </article>
  1431. </div>
  1432. <div class="hidden-sm col-md-2" role="complementary">
  1433. <div class="sideaffix">
  1434. <div class="contribution">
  1435. <ul class="nav">
  1436. </ul>
  1437. </div>
  1438. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  1439. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  1440. </nav>
  1441. </div>
  1442. </div>
  1443. </div>
  1444. </div>
  1445. <footer>
  1446. <div class="grad-bottom"></div>
  1447. <div class="footer">
  1448. <div class="container">
  1449. <span class="pull-right">
  1450. <a href="#top">Back to top</a>
  1451. </span>
  1452. <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
  1453. </div>
  1454. </div>
  1455. </footer>
  1456. </div>
  1457. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  1458. <script type="text/javascript" src="../../styles/docfx.js"></script>
  1459. <script type="text/javascript" src="../../styles/main.js"></script>
  1460. </body>
  1461. </html>