Terminal.Gui.View.html 137 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503
  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.56.7.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">Search Results for <span></span></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></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="Terminal.Gui.View">
  73. <h1 id="Terminal_Gui_View" data-uid="Terminal.Gui.View" class="text-break">Class View
  74. </h1>
  75. <div class="markdown level0 summary">
  76. 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.
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <div class="inheritance">
  80. <h5>Inheritance</h5>
  81. <div class="level0"><span class="xref">System.Object</span></div>
  82. <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
  83. <div class="level2"><span class="xref">View</span></div>
  84. <div class="level3"><a class="xref" href="Terminal.Gui.Button.html">Button</a></div>
  85. <div class="level3"><a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a></div>
  86. <div class="level3"><a class="xref" href="Terminal.Gui.ComboBox.html">ComboBox</a></div>
  87. <div class="level3"><a class="xref" href="Terminal.Gui.FrameView.html">FrameView</a></div>
  88. <div class="level3"><a class="xref" href="Terminal.Gui.HexView.html">HexView</a></div>
  89. <div class="level3"><a class="xref" href="Terminal.Gui.Label.html">Label</a></div>
  90. <div class="level3"><a class="xref" href="Terminal.Gui.ListView.html">ListView</a></div>
  91. <div class="level3"><a class="xref" href="Terminal.Gui.MenuBar.html">MenuBar</a></div>
  92. <div class="level3"><a class="xref" href="Terminal.Gui.ProgressBar.html">ProgressBar</a></div>
  93. <div class="level3"><a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a></div>
  94. <div class="level3"><a class="xref" href="Terminal.Gui.ScrollBarView.html">ScrollBarView</a></div>
  95. <div class="level3"><a class="xref" href="Terminal.Gui.ScrollView.html">ScrollView</a></div>
  96. <div class="level3"><a class="xref" href="Terminal.Gui.StatusBar.html">StatusBar</a></div>
  97. <div class="level3"><a class="xref" href="Terminal.Gui.TableView.html">TableView</a></div>
  98. <div class="level3"><a class="xref" href="Terminal.Gui.TextField.html">TextField</a></div>
  99. <div class="level3"><a class="xref" href="Terminal.Gui.TextView.html">TextView</a></div>
  100. <div class="level3"><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></div>
  101. <div class="level3"><a class="xref" href="Terminal.Gui.TreeView-1.html">TreeView&lt;T&gt;</a></div>
  102. </div>
  103. <div classs="implements">
  104. <h5>Implements</h5>
  105. <div><span class="xref">System.IDisposable</span></div>
  106. <div><span class="xref">System.ComponentModel.ISupportInitializeNotification</span></div>
  107. <div><span class="xref">System.ComponentModel.ISupportInitialize</span></div>
  108. </div>
  109. <div class="inheritedMembers">
  110. <h5>Inherited Members</h5>
  111. <div>
  112. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a>
  113. </div>
  114. <div>
  115. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose">Responder.Dispose()</a>
  116. </div>
  117. <div>
  118. <span class="xref">System.Object.Equals(System.Object)</span>
  119. </div>
  120. <div>
  121. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  122. </div>
  123. <div>
  124. <span class="xref">System.Object.GetHashCode()</span>
  125. </div>
  126. <div>
  127. <span class="xref">System.Object.GetType()</span>
  128. </div>
  129. <div>
  130. <span class="xref">System.Object.MemberwiseClone()</span>
  131. </div>
  132. <div>
  133. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  134. </div>
  135. </div>
  136. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  137. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  138. <h5 id="Terminal_Gui_View_syntax">Syntax</h5>
  139. <div class="codewrapper">
  140. <pre><code class="lang-csharp hljs">public class View : Responder, IDisposable, ISupportInitializeNotification, ISupportInitialize</code></pre>
  141. </div>
  142. <h5 id="Terminal_Gui_View_remarks"><strong>Remarks</strong></h5>
  143. <div class="markdown level0 remarks">
  144. <p>
  145. The View defines the base functionality for user interface elements in Terminal.Gui. Views
  146. can contain one or more subviews, can respond to user input and render themselves on the screen.
  147. </p>
  148. <p>
  149. Views supports two layout styles: Absolute or Computed. The choice as to which layout style is used by the View
  150. is determined when the View is initizlied. To create a View using Absolute layout, call a constructor that takes a
  151. Rect parameter to specify the absolute position and size (the <code>View.<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a></code>)/. To create a View
  152. using Computed layout use a constructor that does not take a Rect parametr and set the X, Y, Width and Height
  153. properties on the view. Both approaches use coordinates that are relative to the container they are being added to.
  154. </p>
  155. <p>
  156. To switch between Absolute and Computed layout, use the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">LayoutStyle</a> property.
  157. </p>
  158. <p>
  159. Computed layout is more flexible and supports dynamic console apps where controls adjust layout
  160. as the terminal resizes or other Views change size or position. The X, Y, Width and Height
  161. properties are Dim and Pos objects that dynamically update the position of a view.
  162. The X and Y properties are of type <a class="xref" href="Terminal.Gui.Pos.html">Pos</a>
  163. and you can use either absolute positions, percentages or anchor
  164. points. The Width and Height properties are of type
  165. <a class="xref" href="Terminal.Gui.Dim.html">Dim</a> and can use absolute position,
  166. percentages and anchors. These are useful as they will take
  167. care of repositioning views when view&apos;s frames are resized or
  168. if the terminal size changes.
  169. </p>
  170. <p>
  171. Absolute layout requires specifying coordinates and sizes of Views explicitly, and the
  172. View will typcialy stay in a fixed position and size. To change the position and size use the
  173. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> property.
  174. </p>
  175. <p>
  176. Subviews (child views) can be added to a View by calling the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">Add(View)</a> method.
  177. The container of a View can be accessed with the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">SuperView</a> property.
  178. </p>
  179. <p>
  180. To flag a region of the View&apos;s <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">Bounds</a> to be redrawn call <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">SetNeedsDisplay(Rect)</a>. To flag the entire view
  181. for redraw call <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">SetNeedsDisplay()</a>.
  182. </p>
  183. <p>
  184. Views have a <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">ColorScheme</a> property that defines the default colors that subviews
  185. should use for rendering. This ensures that the views fit in the context where
  186. they are being used, and allows for themes to be plugged in. For example, the
  187. default colors for windows and toplevels uses a blue background, while it uses
  188. a white background for dialog boxes and a red background for errors.
  189. </p>
  190. <p>
  191. Subclasses should not rely on <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">ColorScheme</a> being
  192. set at construction time. If a <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">ColorScheme</a> is not set on a view, the view will inherit the
  193. value from its <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">SuperView</a> and the value might only be valid once a view has been
  194. added to a SuperView.
  195. </p>
  196. <p>
  197. By using <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">ColorScheme</a> applications will work both
  198. in color as well as black and white displays.
  199. </p>
  200. <p>
  201. Views that are focusable should implement the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">PositionCursor()</a> to make sure that
  202. the cursor is placed in a location that makes sense. Unix terminals do not have
  203. a way of hiding the cursor, so it can be distracting to have the cursor left at
  204. the last focused view. So views should make sure that they place the cursor
  205. in a visually sensible place.
  206. </p>
  207. <p>
  208. The <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">LayoutSubviews()</a> method is invoked when the size or layout of a view has
  209. changed. The default processing system will keep the size and dimensions
  210. for views that use the <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a>, and will recompute the
  211. frames for the vies that use <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a>.
  212. </p>
  213. </div>
  214. <h3 id="constructors">Constructors
  215. </h3>
  216. <a id="Terminal_Gui_View__ctor_" data-uid="Terminal.Gui.View.#ctor*"></a>
  217. <h4 id="Terminal_Gui_View__ctor" data-uid="Terminal.Gui.View.#ctor">View()</h4>
  218. <div class="markdown level1 summary">
  219. Initializes a new instance of <a class="xref" href="Terminal.Gui.View.html">View</a> using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a> layout.
  220. </div>
  221. <div class="markdown level1 conceptual"></div>
  222. <h5 class="decalaration">Declaration</h5>
  223. <div class="codewrapper">
  224. <pre><code class="lang-csharp hljs">public View()</code></pre>
  225. </div>
  226. <h5 id="Terminal_Gui_View__ctor_remarks">Remarks</h5>
  227. <div class="markdown level1 remarks">
  228. <p>
  229. Use <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">X</a>, <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">Y</a>, <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">Width</a>, and <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">Height</a> properties to dynamically control the size and location of the view.
  230. The <a class="xref" href="Terminal.Gui.Label.html">Label</a> will be created using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a>
  231. coordinates. The initial size (<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> will be
  232. adjusted to fit the contents of <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">Text</a>, including newlines (&apos;\n&apos;) for multiple lines.
  233. </p>
  234. <p>
  235. If <code>Height</code> is greater than one, word wrapping is provided.
  236. </p>
  237. <p>
  238. This constructor intitalize a View with a <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">LayoutStyle</a> of <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a>.
  239. Use <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">X</a>, <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">Y</a>, <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">Width</a>, and <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">Height</a> properties to dynamically control the size and location of the view.
  240. </p>
  241. </div>
  242. <a id="Terminal_Gui_View__ctor_" data-uid="Terminal.Gui.View.#ctor*"></a>
  243. <h4 id="Terminal_Gui_View__ctor_NStack_ustring_" data-uid="Terminal.Gui.View.#ctor(NStack.ustring)">View(ustring)</h4>
  244. <div class="markdown level1 summary">
  245. Initializes a new instance of <a class="xref" href="Terminal.Gui.View.html">View</a> using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a> layout.
  246. </div>
  247. <div class="markdown level1 conceptual"></div>
  248. <h5 class="decalaration">Declaration</h5>
  249. <div class="codewrapper">
  250. <pre><code class="lang-csharp hljs">public View(ustring text)</code></pre>
  251. </div>
  252. <h5 class="parameters">Parameters</h5>
  253. <table class="table table-bordered table-striped table-condensed">
  254. <thead>
  255. <tr>
  256. <th>Type</th>
  257. <th>Name</th>
  258. <th>Description</th>
  259. </tr>
  260. </thead>
  261. <tbody>
  262. <tr>
  263. <td><span class="xref">NStack.ustring</span></td>
  264. <td><span class="parametername">text</span></td>
  265. <td>text to initialize the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">Text</a> property with.</td>
  266. </tr>
  267. </tbody>
  268. </table>
  269. <h5 id="Terminal_Gui_View__ctor_NStack_ustring__remarks">Remarks</h5>
  270. <div class="markdown level1 remarks">
  271. <p>
  272. The <a class="xref" href="Terminal.Gui.View.html">View</a> will be created using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a>
  273. coordinates with the given string. The initial size (<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> will be
  274. adjusted to fit the contents of <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">Text</a>, including newlines (&apos;\n&apos;) for multiple lines.
  275. </p>
  276. <p>
  277. If <code>Height</code> is greater than one, word wrapping is provided.
  278. </p>
  279. </div>
  280. <a id="Terminal_Gui_View__ctor_" data-uid="Terminal.Gui.View.#ctor*"></a>
  281. <h4 id="Terminal_Gui_View__ctor_System_Int32_System_Int32_NStack_ustring_" data-uid="Terminal.Gui.View.#ctor(System.Int32,System.Int32,NStack.ustring)">View(Int32, Int32, ustring)</h4>
  282. <div class="markdown level1 summary">
  283. Initializes a new instance of <a class="xref" href="Terminal.Gui.View.html">View</a> using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> layout.
  284. </div>
  285. <div class="markdown level1 conceptual"></div>
  286. <h5 class="decalaration">Declaration</h5>
  287. <div class="codewrapper">
  288. <pre><code class="lang-csharp hljs">public View(int x, int y, ustring text)</code></pre>
  289. </div>
  290. <h5 class="parameters">Parameters</h5>
  291. <table class="table table-bordered table-striped table-condensed">
  292. <thead>
  293. <tr>
  294. <th>Type</th>
  295. <th>Name</th>
  296. <th>Description</th>
  297. </tr>
  298. </thead>
  299. <tbody>
  300. <tr>
  301. <td><span class="xref">System.Int32</span></td>
  302. <td><span class="parametername">x</span></td>
  303. <td>column to locate the Label.</td>
  304. </tr>
  305. <tr>
  306. <td><span class="xref">System.Int32</span></td>
  307. <td><span class="parametername">y</span></td>
  308. <td>row to locate the Label.</td>
  309. </tr>
  310. <tr>
  311. <td><span class="xref">NStack.ustring</span></td>
  312. <td><span class="parametername">text</span></td>
  313. <td>text to initialize the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">Text</a> property with.</td>
  314. </tr>
  315. </tbody>
  316. </table>
  317. <h5 id="Terminal_Gui_View__ctor_System_Int32_System_Int32_NStack_ustring__remarks">Remarks</h5>
  318. <div class="markdown level1 remarks">
  319. <p>
  320. The <a class="xref" href="Terminal.Gui.View.html">View</a> will be created at the given
  321. coordinates with the given string. The size (<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> will be
  322. adjusted to fit the contents of <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">Text</a>, including newlines (&apos;\n&apos;) for multiple lines.
  323. </p>
  324. <p>
  325. No line wrapping is provided.
  326. </p>
  327. </div>
  328. <a id="Terminal_Gui_View__ctor_" data-uid="Terminal.Gui.View.#ctor*"></a>
  329. <h4 id="Terminal_Gui_View__ctor_Terminal_Gui_Rect_" data-uid="Terminal.Gui.View.#ctor(Terminal.Gui.Rect)">View(Rect)</h4>
  330. <div class="markdown level1 summary">
  331. Initializes a new instance of a <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> <a class="xref" href="Terminal.Gui.View.html">View</a> class with the absolute
  332. dimensions specified in the <code>frame</code> parameter.
  333. </div>
  334. <div class="markdown level1 conceptual"></div>
  335. <h5 class="decalaration">Declaration</h5>
  336. <div class="codewrapper">
  337. <pre><code class="lang-csharp hljs">public View(Rect frame)</code></pre>
  338. </div>
  339. <h5 class="parameters">Parameters</h5>
  340. <table class="table table-bordered table-striped table-condensed">
  341. <thead>
  342. <tr>
  343. <th>Type</th>
  344. <th>Name</th>
  345. <th>Description</th>
  346. </tr>
  347. </thead>
  348. <tbody>
  349. <tr>
  350. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  351. <td><span class="parametername">frame</span></td>
  352. <td>The region covered by this view.</td>
  353. </tr>
  354. </tbody>
  355. </table>
  356. <h5 id="Terminal_Gui_View__ctor_Terminal_Gui_Rect__remarks">Remarks</h5>
  357. <div class="markdown level1 remarks">
  358. This constructor intitalize a View with a <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">LayoutStyle</a> of <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a>. Use <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View__ctor">View()</a> to
  359. initialize a View with <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">LayoutStyle</a> of <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a>
  360. </div>
  361. <a id="Terminal_Gui_View__ctor_" data-uid="Terminal.Gui.View.#ctor*"></a>
  362. <h4 id="Terminal_Gui_View__ctor_Terminal_Gui_Rect_NStack_ustring_" data-uid="Terminal.Gui.View.#ctor(Terminal.Gui.Rect,NStack.ustring)">View(Rect, ustring)</h4>
  363. <div class="markdown level1 summary">
  364. Initializes a new instance of <a class="xref" href="Terminal.Gui.View.html">View</a> using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> layout.
  365. </div>
  366. <div class="markdown level1 conceptual"></div>
  367. <h5 class="decalaration">Declaration</h5>
  368. <div class="codewrapper">
  369. <pre><code class="lang-csharp hljs">public View(Rect rect, ustring text)</code></pre>
  370. </div>
  371. <h5 class="parameters">Parameters</h5>
  372. <table class="table table-bordered table-striped table-condensed">
  373. <thead>
  374. <tr>
  375. <th>Type</th>
  376. <th>Name</th>
  377. <th>Description</th>
  378. </tr>
  379. </thead>
  380. <tbody>
  381. <tr>
  382. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  383. <td><span class="parametername">rect</span></td>
  384. <td>Location.</td>
  385. </tr>
  386. <tr>
  387. <td><span class="xref">NStack.ustring</span></td>
  388. <td><span class="parametername">text</span></td>
  389. <td>text to initialize the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">Text</a> property with.</td>
  390. </tr>
  391. </tbody>
  392. </table>
  393. <h5 id="Terminal_Gui_View__ctor_Terminal_Gui_Rect_NStack_ustring__remarks">Remarks</h5>
  394. <div class="markdown level1 remarks">
  395. <p>
  396. The <a class="xref" href="Terminal.Gui.View.html">View</a> will be created at the given
  397. coordinates with the given string. The initial size (<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> will be
  398. adjusted to fit the contents of <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">Text</a>, including newlines (&apos;\n&apos;) for multiple lines.
  399. </p>
  400. <p>
  401. If <code>rect.Height</code> is greater than one, word wrapping is provided.
  402. </p>
  403. </div>
  404. <h3 id="properties">Properties
  405. </h3>
  406. <a id="Terminal_Gui_View_AutoSize_" data-uid="Terminal.Gui.View.AutoSize*"></a>
  407. <h4 id="Terminal_Gui_View_AutoSize" data-uid="Terminal.Gui.View.AutoSize">AutoSize</h4>
  408. <div class="markdown level1 summary">
  409. Used by <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">Text</a> to resize the view&apos;s <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">Bounds</a> with the <a class="xref" href="Terminal.Gui.TextFormatter.html#Terminal_Gui_TextFormatter_Size">Size</a>.
  410. Setting <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AutoSize">AutoSize</a> to true only work if the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">Width</a> and <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">Height</a> are null or
  411. <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> values and doesn&apos;t work with <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a> layout,
  412. to avoid breaking the <a class="xref" href="Terminal.Gui.Pos.html">Pos</a> and <a class="xref" href="Terminal.Gui.Dim.html">Dim</a> settings.
  413. </div>
  414. <div class="markdown level1 conceptual"></div>
  415. <h5 class="decalaration">Declaration</h5>
  416. <div class="codewrapper">
  417. <pre><code class="lang-csharp hljs">public virtual bool AutoSize { get; set; }</code></pre>
  418. </div>
  419. <h5 class="propertyValue">Property Value</h5>
  420. <table class="table table-bordered table-striped table-condensed">
  421. <thead>
  422. <tr>
  423. <th>Type</th>
  424. <th>Description</th>
  425. </tr>
  426. </thead>
  427. <tbody>
  428. <tr>
  429. <td><span class="xref">System.Boolean</span></td>
  430. <td></td>
  431. </tr>
  432. </tbody>
  433. </table>
  434. <a id="Terminal_Gui_View_Bounds_" data-uid="Terminal.Gui.View.Bounds*"></a>
  435. <h4 id="Terminal_Gui_View_Bounds" data-uid="Terminal.Gui.View.Bounds">Bounds</h4>
  436. <div class="markdown level1 summary">
  437. The bounds represent the View-relative rectangle used for this view; the area inside of the view.
  438. </div>
  439. <div class="markdown level1 conceptual"></div>
  440. <h5 class="decalaration">Declaration</h5>
  441. <div class="codewrapper">
  442. <pre><code class="lang-csharp hljs">public Rect Bounds { get; set; }</code></pre>
  443. </div>
  444. <h5 class="propertyValue">Property Value</h5>
  445. <table class="table table-bordered table-striped table-condensed">
  446. <thead>
  447. <tr>
  448. <th>Type</th>
  449. <th>Description</th>
  450. </tr>
  451. </thead>
  452. <tbody>
  453. <tr>
  454. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  455. <td>The bounds.</td>
  456. </tr>
  457. </tbody>
  458. </table>
  459. <h5 id="Terminal_Gui_View_Bounds_remarks">Remarks</h5>
  460. <div class="markdown level1 remarks">
  461. <p>
  462. Updates to the Bounds update the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a>,
  463. and has the same side effects as updating the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a>.
  464. </p>
  465. <p>
  466. Because <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">Bounds</a> coordinates are relative to the upper-left corner of the <a class="xref" href="Terminal.Gui.View.html">View</a>,
  467. the coordinates of the upper-left corner of the rectangle returned by this property are (0,0).
  468. Use this property to obtain the size and coordinates of the client area of the
  469. control for tasks such as drawing on the surface of the control.
  470. </p>
  471. </div>
  472. <a id="Terminal_Gui_View_CanFocus_" data-uid="Terminal.Gui.View.CanFocus*"></a>
  473. <h4 id="Terminal_Gui_View_CanFocus" data-uid="Terminal.Gui.View.CanFocus">CanFocus</h4>
  474. <div class="markdown level1 summary">
  475. Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.Responder.html">Responder</a> can focus.
  476. </div>
  477. <div class="markdown level1 conceptual"></div>
  478. <h5 class="decalaration">Declaration</h5>
  479. <div class="codewrapper">
  480. <pre><code class="lang-csharp hljs">public override bool CanFocus { get; set; }</code></pre>
  481. </div>
  482. <h5 class="propertyValue">Property Value</h5>
  483. <table class="table table-bordered table-striped table-condensed">
  484. <thead>
  485. <tr>
  486. <th>Type</th>
  487. <th>Description</th>
  488. </tr>
  489. </thead>
  490. <tbody>
  491. <tr>
  492. <td><span class="xref">System.Boolean</span></td>
  493. <td><code>true</code> if can focus; otherwise, <code>false</code>.</td>
  494. </tr>
  495. </tbody>
  496. </table>
  497. <h5 class="overrides">Overrides</h5>
  498. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_CanFocus">Responder.CanFocus</a></div>
  499. <a id="Terminal_Gui_View_ColorScheme_" data-uid="Terminal.Gui.View.ColorScheme*"></a>
  500. <h4 id="Terminal_Gui_View_ColorScheme" data-uid="Terminal.Gui.View.ColorScheme">ColorScheme</h4>
  501. <div class="markdown level1 summary">
  502. The color scheme for this view, if it is not defined, it returns the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">SuperView</a>&apos;s
  503. color scheme.
  504. </div>
  505. <div class="markdown level1 conceptual"></div>
  506. <h5 class="decalaration">Declaration</h5>
  507. <div class="codewrapper">
  508. <pre><code class="lang-csharp hljs">public ColorScheme ColorScheme { get; set; }</code></pre>
  509. </div>
  510. <h5 class="propertyValue">Property Value</h5>
  511. <table class="table table-bordered table-striped table-condensed">
  512. <thead>
  513. <tr>
  514. <th>Type</th>
  515. <th>Description</th>
  516. </tr>
  517. </thead>
  518. <tbody>
  519. <tr>
  520. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  521. <td></td>
  522. </tr>
  523. </tbody>
  524. </table>
  525. <a id="Terminal_Gui_View_Data_" data-uid="Terminal.Gui.View.Data*"></a>
  526. <h4 id="Terminal_Gui_View_Data" data-uid="Terminal.Gui.View.Data">Data</h4>
  527. <div class="markdown level1 summary">
  528. Gets or sets arbitrary data for the view.
  529. </div>
  530. <div class="markdown level1 conceptual"></div>
  531. <h5 class="decalaration">Declaration</h5>
  532. <div class="codewrapper">
  533. <pre><code class="lang-csharp hljs">public object Data { get; set; }</code></pre>
  534. </div>
  535. <h5 class="propertyValue">Property Value</h5>
  536. <table class="table table-bordered table-striped table-condensed">
  537. <thead>
  538. <tr>
  539. <th>Type</th>
  540. <th>Description</th>
  541. </tr>
  542. </thead>
  543. <tbody>
  544. <tr>
  545. <td><span class="xref">System.Object</span></td>
  546. <td></td>
  547. </tr>
  548. </tbody>
  549. </table>
  550. <h5 id="Terminal_Gui_View_Data_remarks">Remarks</h5>
  551. <div class="markdown level1 remarks">This property is not used internally.</div>
  552. <a id="Terminal_Gui_View_Driver_" data-uid="Terminal.Gui.View.Driver*"></a>
  553. <h4 id="Terminal_Gui_View_Driver" data-uid="Terminal.Gui.View.Driver">Driver</h4>
  554. <div class="markdown level1 summary">
  555. Points to the current driver in use by the view, it is a convenience property
  556. for simplifying the development of new views.
  557. </div>
  558. <div class="markdown level1 conceptual"></div>
  559. <h5 class="decalaration">Declaration</h5>
  560. <div class="codewrapper">
  561. <pre><code class="lang-csharp hljs">public static ConsoleDriver Driver { get; }</code></pre>
  562. </div>
  563. <h5 class="propertyValue">Property Value</h5>
  564. <table class="table table-bordered table-striped table-condensed">
  565. <thead>
  566. <tr>
  567. <th>Type</th>
  568. <th>Description</th>
  569. </tr>
  570. </thead>
  571. <tbody>
  572. <tr>
  573. <td><a class="xref" href="Terminal.Gui.ConsoleDriver.html">ConsoleDriver</a></td>
  574. <td></td>
  575. </tr>
  576. </tbody>
  577. </table>
  578. <a id="Terminal_Gui_View_Focused_" data-uid="Terminal.Gui.View.Focused*"></a>
  579. <h4 id="Terminal_Gui_View_Focused" data-uid="Terminal.Gui.View.Focused">Focused</h4>
  580. <div class="markdown level1 summary">
  581. Returns the currently focused view inside this view, or null if nothing is focused.
  582. </div>
  583. <div class="markdown level1 conceptual"></div>
  584. <h5 class="decalaration">Declaration</h5>
  585. <div class="codewrapper">
  586. <pre><code class="lang-csharp hljs">public View Focused { get; }</code></pre>
  587. </div>
  588. <h5 class="propertyValue">Property Value</h5>
  589. <table class="table table-bordered table-striped table-condensed">
  590. <thead>
  591. <tr>
  592. <th>Type</th>
  593. <th>Description</th>
  594. </tr>
  595. </thead>
  596. <tbody>
  597. <tr>
  598. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  599. <td>The focused.</td>
  600. </tr>
  601. </tbody>
  602. </table>
  603. <a id="Terminal_Gui_View_Frame_" data-uid="Terminal.Gui.View.Frame*"></a>
  604. <h4 id="Terminal_Gui_View_Frame" data-uid="Terminal.Gui.View.Frame">Frame</h4>
  605. <div class="markdown level1 summary">
  606. Gets or sets the frame for the view. The frame is relative to the view&apos;s container (<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">SuperView</a>).
  607. </div>
  608. <div class="markdown level1 conceptual"></div>
  609. <h5 class="decalaration">Declaration</h5>
  610. <div class="codewrapper">
  611. <pre><code class="lang-csharp hljs">public virtual Rect Frame { get; set; }</code></pre>
  612. </div>
  613. <h5 class="propertyValue">Property Value</h5>
  614. <table class="table table-bordered table-striped table-condensed">
  615. <thead>
  616. <tr>
  617. <th>Type</th>
  618. <th>Description</th>
  619. </tr>
  620. </thead>
  621. <tbody>
  622. <tr>
  623. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  624. <td>The frame.</td>
  625. </tr>
  626. </tbody>
  627. </table>
  628. <h5 id="Terminal_Gui_View_Frame_remarks">Remarks</h5>
  629. <div class="markdown level1 remarks">
  630. <p>
  631. Change the Frame when using the <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> layout style to move or resize views.
  632. </p>
  633. <p>
  634. Altering the Frame of a view will trigger the redrawing of the
  635. view as well as the redrawing of the affected regions of the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">SuperView</a>.
  636. </p>
  637. </div>
  638. <a id="Terminal_Gui_View_HasFocus_" data-uid="Terminal.Gui.View.HasFocus*"></a>
  639. <h4 id="Terminal_Gui_View_HasFocus" data-uid="Terminal.Gui.View.HasFocus">HasFocus</h4>
  640. <div class="markdown level1 summary">
  641. Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.Responder.html">Responder</a> has focus.
  642. </div>
  643. <div class="markdown level1 conceptual"></div>
  644. <h5 class="decalaration">Declaration</h5>
  645. <div class="codewrapper">
  646. <pre><code class="lang-csharp hljs">public override bool HasFocus { get; }</code></pre>
  647. </div>
  648. <h5 class="propertyValue">Property Value</h5>
  649. <table class="table table-bordered table-striped table-condensed">
  650. <thead>
  651. <tr>
  652. <th>Type</th>
  653. <th>Description</th>
  654. </tr>
  655. </thead>
  656. <tbody>
  657. <tr>
  658. <td><span class="xref">System.Boolean</span></td>
  659. <td><code>true</code> if has focus; otherwise, <code>false</code>.</td>
  660. </tr>
  661. </tbody>
  662. </table>
  663. <h5 class="overrides">Overrides</h5>
  664. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_HasFocus">Responder.HasFocus</a></div>
  665. <a id="Terminal_Gui_View_Height_" data-uid="Terminal.Gui.View.Height*"></a>
  666. <h4 id="Terminal_Gui_View_Height" data-uid="Terminal.Gui.View.Height">Height</h4>
  667. <div class="markdown level1 summary">
  668. Gets or sets the height of the view. Only used whe <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">LayoutStyle</a> is <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a>.
  669. </div>
  670. <div class="markdown level1 conceptual"></div>
  671. <h5 class="decalaration">Declaration</h5>
  672. <div class="codewrapper">
  673. <pre><code class="lang-csharp hljs">public Dim Height { get; set; }</code></pre>
  674. </div>
  675. <h5 class="propertyValue">Property Value</h5>
  676. <table class="table table-bordered table-striped table-condensed">
  677. <thead>
  678. <tr>
  679. <th>Type</th>
  680. <th>Description</th>
  681. </tr>
  682. </thead>
  683. <tbody>
  684. <tr>
  685. <td><a class="xref" href="Terminal.Gui.Dim.html">Dim</a></td>
  686. <td>The height.</td>
  687. </tr>
  688. </tbody>
  689. </table>
  690. <a id="Terminal_Gui_View_HotKey_" data-uid="Terminal.Gui.View.HotKey*"></a>
  691. <h4 id="Terminal_Gui_View_HotKey" data-uid="Terminal.Gui.View.HotKey">HotKey</h4>
  692. <div class="markdown level1 summary">
  693. Gets or sets the HotKey defined for this view. A user pressing HotKey on the keyboard while this view has focus will cause the Clicked event to fire.
  694. </div>
  695. <div class="markdown level1 conceptual"></div>
  696. <h5 class="decalaration">Declaration</h5>
  697. <div class="codewrapper">
  698. <pre><code class="lang-csharp hljs">public Key HotKey { get; set; }</code></pre>
  699. </div>
  700. <h5 class="propertyValue">Property Value</h5>
  701. <table class="table table-bordered table-striped table-condensed">
  702. <thead>
  703. <tr>
  704. <th>Type</th>
  705. <th>Description</th>
  706. </tr>
  707. </thead>
  708. <tbody>
  709. <tr>
  710. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  711. <td></td>
  712. </tr>
  713. </tbody>
  714. </table>
  715. <a id="Terminal_Gui_View_HotKeySpecifier_" data-uid="Terminal.Gui.View.HotKeySpecifier*"></a>
  716. <h4 id="Terminal_Gui_View_HotKeySpecifier" data-uid="Terminal.Gui.View.HotKeySpecifier">HotKeySpecifier</h4>
  717. <div class="markdown level1 summary">
  718. Gets or sets the specifier character for the hotkey (e.g. &apos;_&apos;). Set to &apos;\xffff&apos; to disable hotkey support for this View instance. The default is &apos;\xffff&apos;.
  719. </div>
  720. <div class="markdown level1 conceptual"></div>
  721. <h5 class="decalaration">Declaration</h5>
  722. <div class="codewrapper">
  723. <pre><code class="lang-csharp hljs">public Rune HotKeySpecifier { get; set; }</code></pre>
  724. </div>
  725. <h5 class="propertyValue">Property Value</h5>
  726. <table class="table table-bordered table-striped table-condensed">
  727. <thead>
  728. <tr>
  729. <th>Type</th>
  730. <th>Description</th>
  731. </tr>
  732. </thead>
  733. <tbody>
  734. <tr>
  735. <td><span class="xref">System.Rune</span></td>
  736. <td></td>
  737. </tr>
  738. </tbody>
  739. </table>
  740. <a id="Terminal_Gui_View_Id_" data-uid="Terminal.Gui.View.Id*"></a>
  741. <h4 id="Terminal_Gui_View_Id" data-uid="Terminal.Gui.View.Id">Id</h4>
  742. <div class="markdown level1 summary">
  743. Gets or sets an identifier for the view;
  744. </div>
  745. <div class="markdown level1 conceptual"></div>
  746. <h5 class="decalaration">Declaration</h5>
  747. <div class="codewrapper">
  748. <pre><code class="lang-csharp hljs">public ustring Id { get; set; }</code></pre>
  749. </div>
  750. <h5 class="propertyValue">Property Value</h5>
  751. <table class="table table-bordered table-striped table-condensed">
  752. <thead>
  753. <tr>
  754. <th>Type</th>
  755. <th>Description</th>
  756. </tr>
  757. </thead>
  758. <tbody>
  759. <tr>
  760. <td><span class="xref">NStack.ustring</span></td>
  761. <td>The identifier.</td>
  762. </tr>
  763. </tbody>
  764. </table>
  765. <h5 id="Terminal_Gui_View_Id_remarks">Remarks</h5>
  766. <div class="markdown level1 remarks">The id should be unique across all Views that share a SuperView.</div>
  767. <a id="Terminal_Gui_View_IsCurrentTop_" data-uid="Terminal.Gui.View.IsCurrentTop*"></a>
  768. <h4 id="Terminal_Gui_View_IsCurrentTop" data-uid="Terminal.Gui.View.IsCurrentTop">IsCurrentTop</h4>
  769. <div class="markdown level1 summary">
  770. Returns a value indicating if this View is currently on Top (Active)
  771. </div>
  772. <div class="markdown level1 conceptual"></div>
  773. <h5 class="decalaration">Declaration</h5>
  774. <div class="codewrapper">
  775. <pre><code class="lang-csharp hljs">public bool IsCurrentTop { get; }</code></pre>
  776. </div>
  777. <h5 class="propertyValue">Property Value</h5>
  778. <table class="table table-bordered table-striped table-condensed">
  779. <thead>
  780. <tr>
  781. <th>Type</th>
  782. <th>Description</th>
  783. </tr>
  784. </thead>
  785. <tbody>
  786. <tr>
  787. <td><span class="xref">System.Boolean</span></td>
  788. <td></td>
  789. </tr>
  790. </tbody>
  791. </table>
  792. <a id="Terminal_Gui_View_IsInitialized_" data-uid="Terminal.Gui.View.IsInitialized*"></a>
  793. <h4 id="Terminal_Gui_View_IsInitialized" data-uid="Terminal.Gui.View.IsInitialized">IsInitialized</h4>
  794. <div class="markdown level1 summary">
  795. Get or sets if the <a class="xref" href="Terminal.Gui.View.html">View</a> was already initialized.
  796. This derived from <span class="xref">System.ComponentModel.ISupportInitializeNotification</span> to allow notify all the views that are being initialized.
  797. </div>
  798. <div class="markdown level1 conceptual"></div>
  799. <h5 class="decalaration">Declaration</h5>
  800. <div class="codewrapper">
  801. <pre><code class="lang-csharp hljs">public bool IsInitialized { get; set; }</code></pre>
  802. </div>
  803. <h5 class="propertyValue">Property Value</h5>
  804. <table class="table table-bordered table-striped table-condensed">
  805. <thead>
  806. <tr>
  807. <th>Type</th>
  808. <th>Description</th>
  809. </tr>
  810. </thead>
  811. <tbody>
  812. <tr>
  813. <td><span class="xref">System.Boolean</span></td>
  814. <td></td>
  815. </tr>
  816. </tbody>
  817. </table>
  818. <a id="Terminal_Gui_View_LayoutStyle_" data-uid="Terminal.Gui.View.LayoutStyle*"></a>
  819. <h4 id="Terminal_Gui_View_LayoutStyle" data-uid="Terminal.Gui.View.LayoutStyle">LayoutStyle</h4>
  820. <div class="markdown level1 summary">
  821. Controls how the View&apos;s <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> is computed during the LayoutSubviews method, if the style is set to <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a>,
  822. LayoutSubviews does not change the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a>. If the style is <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a> the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> is updated using
  823. the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">X</a>, <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">Y</a>, <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">Width</a>, and <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">Height</a> properties.
  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 LayoutStyle LayoutStyle { get; set; }</code></pre>
  829. </div>
  830. <h5 class="propertyValue">Property Value</h5>
  831. <table class="table table-bordered table-striped table-condensed">
  832. <thead>
  833. <tr>
  834. <th>Type</th>
  835. <th>Description</th>
  836. </tr>
  837. </thead>
  838. <tbody>
  839. <tr>
  840. <td><a class="xref" href="Terminal.Gui.LayoutStyle.html">LayoutStyle</a></td>
  841. <td>The layout style.</td>
  842. </tr>
  843. </tbody>
  844. </table>
  845. <a id="Terminal_Gui_View_MostFocused_" data-uid="Terminal.Gui.View.MostFocused*"></a>
  846. <h4 id="Terminal_Gui_View_MostFocused" data-uid="Terminal.Gui.View.MostFocused">MostFocused</h4>
  847. <div class="markdown level1 summary">
  848. Returns the most focused view in the chain of subviews (the leaf view that has the focus).
  849. </div>
  850. <div class="markdown level1 conceptual"></div>
  851. <h5 class="decalaration">Declaration</h5>
  852. <div class="codewrapper">
  853. <pre><code class="lang-csharp hljs">public View MostFocused { get; }</code></pre>
  854. </div>
  855. <h5 class="propertyValue">Property Value</h5>
  856. <table class="table table-bordered table-striped table-condensed">
  857. <thead>
  858. <tr>
  859. <th>Type</th>
  860. <th>Description</th>
  861. </tr>
  862. </thead>
  863. <tbody>
  864. <tr>
  865. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  866. <td>The most focused.</td>
  867. </tr>
  868. </tbody>
  869. </table>
  870. <a id="Terminal_Gui_View_Shortcut_" data-uid="Terminal.Gui.View.Shortcut*"></a>
  871. <h4 id="Terminal_Gui_View_Shortcut" data-uid="Terminal.Gui.View.Shortcut">Shortcut</h4>
  872. <div class="markdown level1 summary">
  873. This is the global setting that can be used as a global shortcut to invoke an action if provided.
  874. </div>
  875. <div class="markdown level1 conceptual"></div>
  876. <h5 class="decalaration">Declaration</h5>
  877. <div class="codewrapper">
  878. <pre><code class="lang-csharp hljs">public Key Shortcut { get; set; }</code></pre>
  879. </div>
  880. <h5 class="propertyValue">Property Value</h5>
  881. <table class="table table-bordered table-striped table-condensed">
  882. <thead>
  883. <tr>
  884. <th>Type</th>
  885. <th>Description</th>
  886. </tr>
  887. </thead>
  888. <tbody>
  889. <tr>
  890. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  891. <td></td>
  892. </tr>
  893. </tbody>
  894. </table>
  895. <a id="Terminal_Gui_View_ShortcutAction_" data-uid="Terminal.Gui.View.ShortcutAction*"></a>
  896. <h4 id="Terminal_Gui_View_ShortcutAction" data-uid="Terminal.Gui.View.ShortcutAction">ShortcutAction</h4>
  897. <div class="markdown level1 summary">
  898. The action to run if the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Shortcut">Shortcut</a> is defined.
  899. </div>
  900. <div class="markdown level1 conceptual"></div>
  901. <h5 class="decalaration">Declaration</h5>
  902. <div class="codewrapper">
  903. <pre><code class="lang-csharp hljs">public virtual Action ShortcutAction { get; set; }</code></pre>
  904. </div>
  905. <h5 class="propertyValue">Property Value</h5>
  906. <table class="table table-bordered table-striped table-condensed">
  907. <thead>
  908. <tr>
  909. <th>Type</th>
  910. <th>Description</th>
  911. </tr>
  912. </thead>
  913. <tbody>
  914. <tr>
  915. <td><span class="xref">System.Action</span></td>
  916. <td></td>
  917. </tr>
  918. </tbody>
  919. </table>
  920. <a id="Terminal_Gui_View_ShortcutTag_" data-uid="Terminal.Gui.View.ShortcutTag*"></a>
  921. <h4 id="Terminal_Gui_View_ShortcutTag" data-uid="Terminal.Gui.View.ShortcutTag">ShortcutTag</h4>
  922. <div class="markdown level1 summary">
  923. The keystroke combination used in the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Shortcut">Shortcut</a> as string.
  924. </div>
  925. <div class="markdown level1 conceptual"></div>
  926. <h5 class="decalaration">Declaration</h5>
  927. <div class="codewrapper">
  928. <pre><code class="lang-csharp hljs">public ustring ShortcutTag { get; }</code></pre>
  929. </div>
  930. <h5 class="propertyValue">Property Value</h5>
  931. <table class="table table-bordered table-striped table-condensed">
  932. <thead>
  933. <tr>
  934. <th>Type</th>
  935. <th>Description</th>
  936. </tr>
  937. </thead>
  938. <tbody>
  939. <tr>
  940. <td><span class="xref">NStack.ustring</span></td>
  941. <td></td>
  942. </tr>
  943. </tbody>
  944. </table>
  945. <a id="Terminal_Gui_View_Subviews_" data-uid="Terminal.Gui.View.Subviews*"></a>
  946. <h4 id="Terminal_Gui_View_Subviews" data-uid="Terminal.Gui.View.Subviews">Subviews</h4>
  947. <div class="markdown level1 summary">
  948. This returns a list of the subviews contained by this view.
  949. </div>
  950. <div class="markdown level1 conceptual"></div>
  951. <h5 class="decalaration">Declaration</h5>
  952. <div class="codewrapper">
  953. <pre><code class="lang-csharp hljs">public IList&lt;View&gt; Subviews { get; }</code></pre>
  954. </div>
  955. <h5 class="propertyValue">Property Value</h5>
  956. <table class="table table-bordered table-striped table-condensed">
  957. <thead>
  958. <tr>
  959. <th>Type</th>
  960. <th>Description</th>
  961. </tr>
  962. </thead>
  963. <tbody>
  964. <tr>
  965. <td><span class="xref">System.Collections.Generic.IList</span>&lt;<a class="xref" href="Terminal.Gui.View.html">View</a>&gt;</td>
  966. <td>The subviews.</td>
  967. </tr>
  968. </tbody>
  969. </table>
  970. <a id="Terminal_Gui_View_SuperView_" data-uid="Terminal.Gui.View.SuperView*"></a>
  971. <h4 id="Terminal_Gui_View_SuperView" data-uid="Terminal.Gui.View.SuperView">SuperView</h4>
  972. <div class="markdown level1 summary">
  973. Returns the container for this view, or null if this view has not been added to a container.
  974. </div>
  975. <div class="markdown level1 conceptual"></div>
  976. <h5 class="decalaration">Declaration</h5>
  977. <div class="codewrapper">
  978. <pre><code class="lang-csharp hljs">public View SuperView { get; }</code></pre>
  979. </div>
  980. <h5 class="propertyValue">Property Value</h5>
  981. <table class="table table-bordered table-striped table-condensed">
  982. <thead>
  983. <tr>
  984. <th>Type</th>
  985. <th>Description</th>
  986. </tr>
  987. </thead>
  988. <tbody>
  989. <tr>
  990. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  991. <td>The super view.</td>
  992. </tr>
  993. </tbody>
  994. </table>
  995. <a id="Terminal_Gui_View_TabIndex_" data-uid="Terminal.Gui.View.TabIndex*"></a>
  996. <h4 id="Terminal_Gui_View_TabIndex" data-uid="Terminal.Gui.View.TabIndex">TabIndex</h4>
  997. <div class="markdown level1 summary">
  998. Indicates the index of the current <a class="xref" href="Terminal.Gui.View.html">View</a> from the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndexes">TabIndexes</a> list.
  999. </div>
  1000. <div class="markdown level1 conceptual"></div>
  1001. <h5 class="decalaration">Declaration</h5>
  1002. <div class="codewrapper">
  1003. <pre><code class="lang-csharp hljs">public int TabIndex { get; set; }</code></pre>
  1004. </div>
  1005. <h5 class="propertyValue">Property Value</h5>
  1006. <table class="table table-bordered table-striped table-condensed">
  1007. <thead>
  1008. <tr>
  1009. <th>Type</th>
  1010. <th>Description</th>
  1011. </tr>
  1012. </thead>
  1013. <tbody>
  1014. <tr>
  1015. <td><span class="xref">System.Int32</span></td>
  1016. <td></td>
  1017. </tr>
  1018. </tbody>
  1019. </table>
  1020. <a id="Terminal_Gui_View_TabIndexes_" data-uid="Terminal.Gui.View.TabIndexes*"></a>
  1021. <h4 id="Terminal_Gui_View_TabIndexes" data-uid="Terminal.Gui.View.TabIndexes">TabIndexes</h4>
  1022. <div class="markdown level1 summary">
  1023. This returns a tab index list of the subviews contained by this view.
  1024. </div>
  1025. <div class="markdown level1 conceptual"></div>
  1026. <h5 class="decalaration">Declaration</h5>
  1027. <div class="codewrapper">
  1028. <pre><code class="lang-csharp hljs">public IList&lt;View&gt; TabIndexes { get; }</code></pre>
  1029. </div>
  1030. <h5 class="propertyValue">Property Value</h5>
  1031. <table class="table table-bordered table-striped table-condensed">
  1032. <thead>
  1033. <tr>
  1034. <th>Type</th>
  1035. <th>Description</th>
  1036. </tr>
  1037. </thead>
  1038. <tbody>
  1039. <tr>
  1040. <td><span class="xref">System.Collections.Generic.IList</span>&lt;<a class="xref" href="Terminal.Gui.View.html">View</a>&gt;</td>
  1041. <td>The tabIndexes.</td>
  1042. </tr>
  1043. </tbody>
  1044. </table>
  1045. <a id="Terminal_Gui_View_TabStop_" data-uid="Terminal.Gui.View.TabStop*"></a>
  1046. <h4 id="Terminal_Gui_View_TabStop" data-uid="Terminal.Gui.View.TabStop">TabStop</h4>
  1047. <div class="markdown level1 summary">
  1048. This only be <code>true</code> if the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocus">CanFocus</a> is also <code>true</code> and the focus can be avoided by setting this to <code>false</code>
  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 bool TabStop { get; set; }</code></pre>
  1054. </div>
  1055. <h5 class="propertyValue">Property Value</h5>
  1056. <table class="table table-bordered table-striped table-condensed">
  1057. <thead>
  1058. <tr>
  1059. <th>Type</th>
  1060. <th>Description</th>
  1061. </tr>
  1062. </thead>
  1063. <tbody>
  1064. <tr>
  1065. <td><span class="xref">System.Boolean</span></td>
  1066. <td></td>
  1067. </tr>
  1068. </tbody>
  1069. </table>
  1070. <a id="Terminal_Gui_View_Text_" data-uid="Terminal.Gui.View.Text*"></a>
  1071. <h4 id="Terminal_Gui_View_Text" data-uid="Terminal.Gui.View.Text">Text</h4>
  1072. <div class="markdown level1 summary">
  1073. The text displayed by the <a class="xref" href="Terminal.Gui.View.html">View</a>.
  1074. </div>
  1075. <div class="markdown level1 conceptual"></div>
  1076. <h5 class="decalaration">Declaration</h5>
  1077. <div class="codewrapper">
  1078. <pre><code class="lang-csharp hljs">public virtual ustring Text { get; set; }</code></pre>
  1079. </div>
  1080. <h5 class="propertyValue">Property Value</h5>
  1081. <table class="table table-bordered table-striped table-condensed">
  1082. <thead>
  1083. <tr>
  1084. <th>Type</th>
  1085. <th>Description</th>
  1086. </tr>
  1087. </thead>
  1088. <tbody>
  1089. <tr>
  1090. <td><span class="xref">NStack.ustring</span></td>
  1091. <td></td>
  1092. </tr>
  1093. </tbody>
  1094. </table>
  1095. <h5 id="Terminal_Gui_View_Text_remarks">Remarks</h5>
  1096. <div class="markdown level1 remarks">
  1097. <p>
  1098. If provided, the text will be drawn before any subviews are drawn.
  1099. </p>
  1100. <p>
  1101. The text will be drawn starting at the view origin (0, 0) and will be formatted according
  1102. to the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextAlignment">TextAlignment</a> property. If the view&apos;s height is greater than 1, the
  1103. text will word-wrap to additional lines if it does not fit horizontally. If the view&apos;s height
  1104. is 1, the text will be clipped.
  1105. </p>
  1106. <p>
  1107. Set the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">HotKeySpecifier</a> to enable hotkey support. To disable hotkey support set <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">HotKeySpecifier</a> to
  1108. <code>(Rune)0xffff</code>.
  1109. </p>
  1110. </div>
  1111. <a id="Terminal_Gui_View_TextAlignment_" data-uid="Terminal.Gui.View.TextAlignment*"></a>
  1112. <h4 id="Terminal_Gui_View_TextAlignment" data-uid="Terminal.Gui.View.TextAlignment">TextAlignment</h4>
  1113. <div class="markdown level1 summary">
  1114. Gets or sets how the View&apos;s <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">Text</a> is aligned horizontally when drawn. Changing this property will redisplay the <a class="xref" href="Terminal.Gui.View.html">View</a>.
  1115. </div>
  1116. <div class="markdown level1 conceptual"></div>
  1117. <h5 class="decalaration">Declaration</h5>
  1118. <div class="codewrapper">
  1119. <pre><code class="lang-csharp hljs">public virtual TextAlignment TextAlignment { get; set; }</code></pre>
  1120. </div>
  1121. <h5 class="propertyValue">Property Value</h5>
  1122. <table class="table table-bordered table-striped table-condensed">
  1123. <thead>
  1124. <tr>
  1125. <th>Type</th>
  1126. <th>Description</th>
  1127. </tr>
  1128. </thead>
  1129. <tbody>
  1130. <tr>
  1131. <td><a class="xref" href="Terminal.Gui.TextAlignment.html">TextAlignment</a></td>
  1132. <td>The text alignment.</td>
  1133. </tr>
  1134. </tbody>
  1135. </table>
  1136. <a id="Terminal_Gui_View_Visible_" data-uid="Terminal.Gui.View.Visible*"></a>
  1137. <h4 id="Terminal_Gui_View_Visible" data-uid="Terminal.Gui.View.Visible">Visible</h4>
  1138. <div class="markdown level1 summary">
  1139. Gets or sets the view visibility.
  1140. </div>
  1141. <div class="markdown level1 conceptual"></div>
  1142. <h5 class="decalaration">Declaration</h5>
  1143. <div class="codewrapper">
  1144. <pre><code class="lang-csharp hljs">public bool Visible { get; set; }</code></pre>
  1145. </div>
  1146. <h5 class="propertyValue">Property Value</h5>
  1147. <table class="table table-bordered table-striped table-condensed">
  1148. <thead>
  1149. <tr>
  1150. <th>Type</th>
  1151. <th>Description</th>
  1152. </tr>
  1153. </thead>
  1154. <tbody>
  1155. <tr>
  1156. <td><span class="xref">System.Boolean</span></td>
  1157. <td></td>
  1158. </tr>
  1159. </tbody>
  1160. </table>
  1161. <a id="Terminal_Gui_View_WantContinuousButtonPressed_" data-uid="Terminal.Gui.View.WantContinuousButtonPressed*"></a>
  1162. <h4 id="Terminal_Gui_View_WantContinuousButtonPressed" data-uid="Terminal.Gui.View.WantContinuousButtonPressed">WantContinuousButtonPressed</h4>
  1163. <div class="markdown level1 summary">
  1164. Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.View.html">View</a> want continuous button pressed event.
  1165. </div>
  1166. <div class="markdown level1 conceptual"></div>
  1167. <h5 class="decalaration">Declaration</h5>
  1168. <div class="codewrapper">
  1169. <pre><code class="lang-csharp hljs">public virtual bool WantContinuousButtonPressed { get; set; }</code></pre>
  1170. </div>
  1171. <h5 class="propertyValue">Property Value</h5>
  1172. <table class="table table-bordered table-striped table-condensed">
  1173. <thead>
  1174. <tr>
  1175. <th>Type</th>
  1176. <th>Description</th>
  1177. </tr>
  1178. </thead>
  1179. <tbody>
  1180. <tr>
  1181. <td><span class="xref">System.Boolean</span></td>
  1182. <td></td>
  1183. </tr>
  1184. </tbody>
  1185. </table>
  1186. <a id="Terminal_Gui_View_WantMousePositionReports_" data-uid="Terminal.Gui.View.WantMousePositionReports*"></a>
  1187. <h4 id="Terminal_Gui_View_WantMousePositionReports" data-uid="Terminal.Gui.View.WantMousePositionReports">WantMousePositionReports</h4>
  1188. <div class="markdown level1 summary">
  1189. Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.View.html">View</a> wants mouse position reports.
  1190. </div>
  1191. <div class="markdown level1 conceptual"></div>
  1192. <h5 class="decalaration">Declaration</h5>
  1193. <div class="codewrapper">
  1194. <pre><code class="lang-csharp hljs">public virtual bool WantMousePositionReports { get; set; }</code></pre>
  1195. </div>
  1196. <h5 class="propertyValue">Property Value</h5>
  1197. <table class="table table-bordered table-striped table-condensed">
  1198. <thead>
  1199. <tr>
  1200. <th>Type</th>
  1201. <th>Description</th>
  1202. </tr>
  1203. </thead>
  1204. <tbody>
  1205. <tr>
  1206. <td><span class="xref">System.Boolean</span></td>
  1207. <td><code>true</code> if want mouse position reports; otherwise, <code>false</code>.</td>
  1208. </tr>
  1209. </tbody>
  1210. </table>
  1211. <a id="Terminal_Gui_View_Width_" data-uid="Terminal.Gui.View.Width*"></a>
  1212. <h4 id="Terminal_Gui_View_Width" data-uid="Terminal.Gui.View.Width">Width</h4>
  1213. <div class="markdown level1 summary">
  1214. Gets or sets the width of the view. Only used whe <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">LayoutStyle</a> is <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a>.
  1215. </div>
  1216. <div class="markdown level1 conceptual"></div>
  1217. <h5 class="decalaration">Declaration</h5>
  1218. <div class="codewrapper">
  1219. <pre><code class="lang-csharp hljs">public Dim Width { get; set; }</code></pre>
  1220. </div>
  1221. <h5 class="propertyValue">Property Value</h5>
  1222. <table class="table table-bordered table-striped table-condensed">
  1223. <thead>
  1224. <tr>
  1225. <th>Type</th>
  1226. <th>Description</th>
  1227. </tr>
  1228. </thead>
  1229. <tbody>
  1230. <tr>
  1231. <td><a class="xref" href="Terminal.Gui.Dim.html">Dim</a></td>
  1232. <td>The width.</td>
  1233. </tr>
  1234. </tbody>
  1235. </table>
  1236. <h5 id="Terminal_Gui_View_Width_remarks">Remarks</h5>
  1237. <div class="markdown level1 remarks">
  1238. If <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">LayoutStyle</a> is <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> changing this property has no effect and its value is indeterminate.
  1239. </div>
  1240. <a id="Terminal_Gui_View_X_" data-uid="Terminal.Gui.View.X*"></a>
  1241. <h4 id="Terminal_Gui_View_X" data-uid="Terminal.Gui.View.X">X</h4>
  1242. <div class="markdown level1 summary">
  1243. Gets or sets the X position for the view (the column). Only used whe <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">LayoutStyle</a> is <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a>.
  1244. </div>
  1245. <div class="markdown level1 conceptual"></div>
  1246. <h5 class="decalaration">Declaration</h5>
  1247. <div class="codewrapper">
  1248. <pre><code class="lang-csharp hljs">public Pos X { get; set; }</code></pre>
  1249. </div>
  1250. <h5 class="propertyValue">Property Value</h5>
  1251. <table class="table table-bordered table-striped table-condensed">
  1252. <thead>
  1253. <tr>
  1254. <th>Type</th>
  1255. <th>Description</th>
  1256. </tr>
  1257. </thead>
  1258. <tbody>
  1259. <tr>
  1260. <td><a class="xref" href="Terminal.Gui.Pos.html">Pos</a></td>
  1261. <td>The X Position.</td>
  1262. </tr>
  1263. </tbody>
  1264. </table>
  1265. <h5 id="Terminal_Gui_View_X_remarks">Remarks</h5>
  1266. <div class="markdown level1 remarks">
  1267. If <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">LayoutStyle</a> is <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> changing this property has no effect and its value is indeterminate.
  1268. </div>
  1269. <a id="Terminal_Gui_View_Y_" data-uid="Terminal.Gui.View.Y*"></a>
  1270. <h4 id="Terminal_Gui_View_Y" data-uid="Terminal.Gui.View.Y">Y</h4>
  1271. <div class="markdown level1 summary">
  1272. Gets or sets the Y position for the view (the row). Only used whe <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">LayoutStyle</a> is <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a>.
  1273. </div>
  1274. <div class="markdown level1 conceptual"></div>
  1275. <h5 class="decalaration">Declaration</h5>
  1276. <div class="codewrapper">
  1277. <pre><code class="lang-csharp hljs">public Pos Y { get; set; }</code></pre>
  1278. </div>
  1279. <h5 class="propertyValue">Property Value</h5>
  1280. <table class="table table-bordered table-striped table-condensed">
  1281. <thead>
  1282. <tr>
  1283. <th>Type</th>
  1284. <th>Description</th>
  1285. </tr>
  1286. </thead>
  1287. <tbody>
  1288. <tr>
  1289. <td><a class="xref" href="Terminal.Gui.Pos.html">Pos</a></td>
  1290. <td>The y position (line).</td>
  1291. </tr>
  1292. </tbody>
  1293. </table>
  1294. <h5 id="Terminal_Gui_View_Y_remarks">Remarks</h5>
  1295. <div class="markdown level1 remarks">
  1296. If <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">LayoutStyle</a> is <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> changing this property has no effect and its value is indeterminate.
  1297. </div>
  1298. <h3 id="methods">Methods
  1299. </h3>
  1300. <a id="Terminal_Gui_View_Add_" data-uid="Terminal.Gui.View.Add*"></a>
  1301. <h4 id="Terminal_Gui_View_Add_Terminal_Gui_View_" data-uid="Terminal.Gui.View.Add(Terminal.Gui.View)">Add(View)</h4>
  1302. <div class="markdown level1 summary">
  1303. Adds a subview (child) to this view.
  1304. </div>
  1305. <div class="markdown level1 conceptual"></div>
  1306. <h5 class="decalaration">Declaration</h5>
  1307. <div class="codewrapper">
  1308. <pre><code class="lang-csharp hljs">public virtual void Add(View view)</code></pre>
  1309. </div>
  1310. <h5 class="parameters">Parameters</h5>
  1311. <table class="table table-bordered table-striped table-condensed">
  1312. <thead>
  1313. <tr>
  1314. <th>Type</th>
  1315. <th>Name</th>
  1316. <th>Description</th>
  1317. </tr>
  1318. </thead>
  1319. <tbody>
  1320. <tr>
  1321. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  1322. <td><span class="parametername">view</span></td>
  1323. <td></td>
  1324. </tr>
  1325. </tbody>
  1326. </table>
  1327. <h5 id="Terminal_Gui_View_Add_Terminal_Gui_View__remarks">Remarks</h5>
  1328. <div class="markdown level1 remarks">
  1329. The Views that have been added to this view can be retrieved via the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">Subviews</a> property. See also <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">Remove(View)</a> <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">RemoveAll()</a>
  1330. </div>
  1331. <a id="Terminal_Gui_View_Add_" data-uid="Terminal.Gui.View.Add*"></a>
  1332. <h4 id="Terminal_Gui_View_Add_Terminal_Gui_View___" data-uid="Terminal.Gui.View.Add(Terminal.Gui.View[])">Add(View[])</h4>
  1333. <div class="markdown level1 summary">
  1334. Adds the specified views (children) to the view.
  1335. </div>
  1336. <div class="markdown level1 conceptual"></div>
  1337. <h5 class="decalaration">Declaration</h5>
  1338. <div class="codewrapper">
  1339. <pre><code class="lang-csharp hljs">public void Add(params View[] views)</code></pre>
  1340. </div>
  1341. <h5 class="parameters">Parameters</h5>
  1342. <table class="table table-bordered table-striped table-condensed">
  1343. <thead>
  1344. <tr>
  1345. <th>Type</th>
  1346. <th>Name</th>
  1347. <th>Description</th>
  1348. </tr>
  1349. </thead>
  1350. <tbody>
  1351. <tr>
  1352. <td><a class="xref" href="Terminal.Gui.View.html">View</a>[]</td>
  1353. <td><span class="parametername">views</span></td>
  1354. <td>Array of one or more views (can be optional parameter).</td>
  1355. </tr>
  1356. </tbody>
  1357. </table>
  1358. <h5 id="Terminal_Gui_View_Add_Terminal_Gui_View____remarks">Remarks</h5>
  1359. <div class="markdown level1 remarks">
  1360. The Views that have been added to this view can be retrieved via the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">Subviews</a> property. See also <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">Remove(View)</a> <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">RemoveAll()</a>
  1361. </div>
  1362. <a id="Terminal_Gui_View_AddRune_" data-uid="Terminal.Gui.View.AddRune*"></a>
  1363. <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>
  1364. <div class="markdown level1 summary">
  1365. Displays the specified character in the specified column and row of the View.
  1366. </div>
  1367. <div class="markdown level1 conceptual"></div>
  1368. <h5 class="decalaration">Declaration</h5>
  1369. <div class="codewrapper">
  1370. <pre><code class="lang-csharp hljs">public void AddRune(int col, int row, Rune ch)</code></pre>
  1371. </div>
  1372. <h5 class="parameters">Parameters</h5>
  1373. <table class="table table-bordered table-striped table-condensed">
  1374. <thead>
  1375. <tr>
  1376. <th>Type</th>
  1377. <th>Name</th>
  1378. <th>Description</th>
  1379. </tr>
  1380. </thead>
  1381. <tbody>
  1382. <tr>
  1383. <td><span class="xref">System.Int32</span></td>
  1384. <td><span class="parametername">col</span></td>
  1385. <td>Column (view-relative).</td>
  1386. </tr>
  1387. <tr>
  1388. <td><span class="xref">System.Int32</span></td>
  1389. <td><span class="parametername">row</span></td>
  1390. <td>Row (view-relative).</td>
  1391. </tr>
  1392. <tr>
  1393. <td><span class="xref">System.Rune</span></td>
  1394. <td><span class="parametername">ch</span></td>
  1395. <td>Ch.</td>
  1396. </tr>
  1397. </tbody>
  1398. </table>
  1399. <a id="Terminal_Gui_View_BeginInit_" data-uid="Terminal.Gui.View.BeginInit*"></a>
  1400. <h4 id="Terminal_Gui_View_BeginInit" data-uid="Terminal.Gui.View.BeginInit">BeginInit()</h4>
  1401. <div class="markdown level1 summary">
  1402. This derived from <span class="xref">System.ComponentModel.ISupportInitializeNotification</span> to allow notify all the views that are beginning initialized.
  1403. </div>
  1404. <div class="markdown level1 conceptual"></div>
  1405. <h5 class="decalaration">Declaration</h5>
  1406. <div class="codewrapper">
  1407. <pre><code class="lang-csharp hljs">public void BeginInit()</code></pre>
  1408. </div>
  1409. <a id="Terminal_Gui_View_BringSubviewForward_" data-uid="Terminal.Gui.View.BringSubviewForward*"></a>
  1410. <h4 id="Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_" data-uid="Terminal.Gui.View.BringSubviewForward(Terminal.Gui.View)">BringSubviewForward(View)</h4>
  1411. <div class="markdown level1 summary">
  1412. Moves the subview backwards in the hierarchy, only one step
  1413. </div>
  1414. <div class="markdown level1 conceptual"></div>
  1415. <h5 class="decalaration">Declaration</h5>
  1416. <div class="codewrapper">
  1417. <pre><code class="lang-csharp hljs">public void BringSubviewForward(View subview)</code></pre>
  1418. </div>
  1419. <h5 class="parameters">Parameters</h5>
  1420. <table class="table table-bordered table-striped table-condensed">
  1421. <thead>
  1422. <tr>
  1423. <th>Type</th>
  1424. <th>Name</th>
  1425. <th>Description</th>
  1426. </tr>
  1427. </thead>
  1428. <tbody>
  1429. <tr>
  1430. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  1431. <td><span class="parametername">subview</span></td>
  1432. <td>The subview to send backwards</td>
  1433. </tr>
  1434. </tbody>
  1435. </table>
  1436. <h5 id="Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View__remarks">Remarks</h5>
  1437. <div class="markdown level1 remarks">
  1438. If you want to send the view all the way to the back use SendSubviewToBack.
  1439. </div>
  1440. <a id="Terminal_Gui_View_BringSubviewToFront_" data-uid="Terminal.Gui.View.BringSubviewToFront*"></a>
  1441. <h4 id="Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_" data-uid="Terminal.Gui.View.BringSubviewToFront(Terminal.Gui.View)">BringSubviewToFront(View)</h4>
  1442. <div class="markdown level1 summary">
  1443. Brings the specified subview to the front so it is drawn on top of any other views.
  1444. </div>
  1445. <div class="markdown level1 conceptual"></div>
  1446. <h5 class="decalaration">Declaration</h5>
  1447. <div class="codewrapper">
  1448. <pre><code class="lang-csharp hljs">public void BringSubviewToFront(View subview)</code></pre>
  1449. </div>
  1450. <h5 class="parameters">Parameters</h5>
  1451. <table class="table table-bordered table-striped table-condensed">
  1452. <thead>
  1453. <tr>
  1454. <th>Type</th>
  1455. <th>Name</th>
  1456. <th>Description</th>
  1457. </tr>
  1458. </thead>
  1459. <tbody>
  1460. <tr>
  1461. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  1462. <td><span class="parametername">subview</span></td>
  1463. <td>The subview to send to the front</td>
  1464. </tr>
  1465. </tbody>
  1466. </table>
  1467. <h5 id="Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View__remarks">Remarks</h5>
  1468. <div class="markdown level1 remarks">
  1469. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">SendSubviewToBack(View)</a>.
  1470. </div>
  1471. <a id="Terminal_Gui_View_Clear_" data-uid="Terminal.Gui.View.Clear*"></a>
  1472. <h4 id="Terminal_Gui_View_Clear" data-uid="Terminal.Gui.View.Clear">Clear()</h4>
  1473. <div class="markdown level1 summary">
  1474. Clears the view region with the current color.
  1475. </div>
  1476. <div class="markdown level1 conceptual"></div>
  1477. <h5 class="decalaration">Declaration</h5>
  1478. <div class="codewrapper">
  1479. <pre><code class="lang-csharp hljs">public void Clear()</code></pre>
  1480. </div>
  1481. <h5 id="Terminal_Gui_View_Clear_remarks">Remarks</h5>
  1482. <div class="markdown level1 remarks">
  1483. <p>
  1484. This clears the entire region used by this view.
  1485. </p>
  1486. </div>
  1487. <a id="Terminal_Gui_View_Clear_" data-uid="Terminal.Gui.View.Clear*"></a>
  1488. <h4 id="Terminal_Gui_View_Clear_Terminal_Gui_Rect_" data-uid="Terminal.Gui.View.Clear(Terminal.Gui.Rect)">Clear(Rect)</h4>
  1489. <div class="markdown level1 summary">
  1490. Clears the specified region with the current color.
  1491. </div>
  1492. <div class="markdown level1 conceptual"></div>
  1493. <h5 class="decalaration">Declaration</h5>
  1494. <div class="codewrapper">
  1495. <pre><code class="lang-csharp hljs">public void Clear(Rect regionScreen)</code></pre>
  1496. </div>
  1497. <h5 class="parameters">Parameters</h5>
  1498. <table class="table table-bordered table-striped table-condensed">
  1499. <thead>
  1500. <tr>
  1501. <th>Type</th>
  1502. <th>Name</th>
  1503. <th>Description</th>
  1504. </tr>
  1505. </thead>
  1506. <tbody>
  1507. <tr>
  1508. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1509. <td><span class="parametername">regionScreen</span></td>
  1510. <td>The screen-relative region to clear.</td>
  1511. </tr>
  1512. </tbody>
  1513. </table>
  1514. <h5 id="Terminal_Gui_View_Clear_Terminal_Gui_Rect__remarks">Remarks</h5>
  1515. <div class="markdown level1 remarks">
  1516. </div>
  1517. <a id="Terminal_Gui_View_ClearLayoutNeeded_" data-uid="Terminal.Gui.View.ClearLayoutNeeded*"></a>
  1518. <h4 id="Terminal_Gui_View_ClearLayoutNeeded" data-uid="Terminal.Gui.View.ClearLayoutNeeded">ClearLayoutNeeded()</h4>
  1519. <div class="markdown level1 summary">
  1520. Removes the <span class="xref">Terminal.Gui.View.SetNeedsLayout</span> setting on this view.
  1521. </div>
  1522. <div class="markdown level1 conceptual"></div>
  1523. <h5 class="decalaration">Declaration</h5>
  1524. <div class="codewrapper">
  1525. <pre><code class="lang-csharp hljs">protected void ClearLayoutNeeded()</code></pre>
  1526. </div>
  1527. <a id="Terminal_Gui_View_ClearNeedsDisplay_" data-uid="Terminal.Gui.View.ClearNeedsDisplay*"></a>
  1528. <h4 id="Terminal_Gui_View_ClearNeedsDisplay" data-uid="Terminal.Gui.View.ClearNeedsDisplay">ClearNeedsDisplay()</h4>
  1529. <div class="markdown level1 summary">
  1530. Removes the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">SetNeedsDisplay()</a> and the <span class="xref">Terminal.Gui.View.ChildNeedsDisplay()</span> setting on this view.
  1531. </div>
  1532. <div class="markdown level1 conceptual"></div>
  1533. <h5 class="decalaration">Declaration</h5>
  1534. <div class="codewrapper">
  1535. <pre><code class="lang-csharp hljs">protected void ClearNeedsDisplay()</code></pre>
  1536. </div>
  1537. <a id="Terminal_Gui_View_ClipToBounds_" data-uid="Terminal.Gui.View.ClipToBounds*"></a>
  1538. <h4 id="Terminal_Gui_View_ClipToBounds" data-uid="Terminal.Gui.View.ClipToBounds">ClipToBounds()</h4>
  1539. <div class="markdown level1 summary">
  1540. Sets the <a class="xref" href="Terminal.Gui.ConsoleDriver.html">ConsoleDriver</a>&apos;s clip region to the current View&apos;s <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">Bounds</a>.
  1541. </div>
  1542. <div class="markdown level1 conceptual"></div>
  1543. <h5 class="decalaration">Declaration</h5>
  1544. <div class="codewrapper">
  1545. <pre><code class="lang-csharp hljs">public Rect ClipToBounds()</code></pre>
  1546. </div>
  1547. <h5 class="returns">Returns</h5>
  1548. <table class="table table-bordered table-striped table-condensed">
  1549. <thead>
  1550. <tr>
  1551. <th>Type</th>
  1552. <th>Description</th>
  1553. </tr>
  1554. </thead>
  1555. <tbody>
  1556. <tr>
  1557. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1558. <td>The existing driver&apos;s clip region, which can be then re-eapplied by setting <code><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">Driver</a>.Clip</code> (<a class="xref" href="Terminal.Gui.ConsoleDriver.html#Terminal_Gui_ConsoleDriver_Clip">Clip</a>).</td>
  1559. </tr>
  1560. </tbody>
  1561. </table>
  1562. <h5 id="Terminal_Gui_View_ClipToBounds_remarks">Remarks</h5>
  1563. <div class="markdown level1 remarks">
  1564. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">Bounds</a> is View-relative.
  1565. </div>
  1566. <a id="Terminal_Gui_View_Dispose_" data-uid="Terminal.Gui.View.Dispose*"></a>
  1567. <h4 id="Terminal_Gui_View_Dispose_System_Boolean_" data-uid="Terminal.Gui.View.Dispose(System.Boolean)">Dispose(Boolean)</h4>
  1568. <div class="markdown level1 summary">
  1569. Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
  1570. </div>
  1571. <div class="markdown level1 conceptual"></div>
  1572. <h5 class="decalaration">Declaration</h5>
  1573. <div class="codewrapper">
  1574. <pre><code class="lang-csharp hljs">protected override void Dispose(bool disposing)</code></pre>
  1575. </div>
  1576. <h5 class="parameters">Parameters</h5>
  1577. <table class="table table-bordered table-striped table-condensed">
  1578. <thead>
  1579. <tr>
  1580. <th>Type</th>
  1581. <th>Name</th>
  1582. <th>Description</th>
  1583. </tr>
  1584. </thead>
  1585. <tbody>
  1586. <tr>
  1587. <td><span class="xref">System.Boolean</span></td>
  1588. <td><span class="parametername">disposing</span></td>
  1589. <td></td>
  1590. </tr>
  1591. </tbody>
  1592. </table>
  1593. <h5 class="overrides">Overrides</h5>
  1594. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose_System_Boolean_">Responder.Dispose(Boolean)</a></div>
  1595. <h5 id="Terminal_Gui_View_Dispose_System_Boolean__remarks">Remarks</h5>
  1596. <div class="markdown level1 remarks">
  1597. If disposing equals true, the method has been called directly
  1598. or indirectly by a user&apos;s code. Managed and unmanaged resources
  1599. can be disposed.
  1600. If disposing equals false, the method has been called by the
  1601. runtime from inside the finalizer and you should not reference
  1602. other objects. Only unmanaged resources can be disposed.
  1603. </div>
  1604. <a id="Terminal_Gui_View_DrawFrame_" data-uid="Terminal.Gui.View.DrawFrame*"></a>
  1605. <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>
  1606. <div class="markdown level1 summary">
  1607. Draws a frame in the current view, clipped by the boundary of this view
  1608. </div>
  1609. <div class="markdown level1 conceptual"></div>
  1610. <h5 class="decalaration">Declaration</h5>
  1611. <div class="codewrapper">
  1612. <pre><code class="lang-csharp hljs">public void DrawFrame(Rect region, int padding = 0, bool fill = false)</code></pre>
  1613. </div>
  1614. <h5 class="parameters">Parameters</h5>
  1615. <table class="table table-bordered table-striped table-condensed">
  1616. <thead>
  1617. <tr>
  1618. <th>Type</th>
  1619. <th>Name</th>
  1620. <th>Description</th>
  1621. </tr>
  1622. </thead>
  1623. <tbody>
  1624. <tr>
  1625. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1626. <td><span class="parametername">region</span></td>
  1627. <td>View-relative region for the frame to be drawn.</td>
  1628. </tr>
  1629. <tr>
  1630. <td><span class="xref">System.Int32</span></td>
  1631. <td><span class="parametername">padding</span></td>
  1632. <td>The padding to add around the outside of the drawn frame.</td>
  1633. </tr>
  1634. <tr>
  1635. <td><span class="xref">System.Boolean</span></td>
  1636. <td><span class="parametername">fill</span></td>
  1637. <td>If set to <code>true</code> it fill will the contents.</td>
  1638. </tr>
  1639. </tbody>
  1640. </table>
  1641. <a id="Terminal_Gui_View_DrawHotString_" data-uid="Terminal.Gui.View.DrawHotString*"></a>
  1642. <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>
  1643. <div class="markdown level1 summary">
  1644. Utility function to draw strings that contains a hotkey using a <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">ColorScheme</a> and the &quot;focused&quot; state.
  1645. </div>
  1646. <div class="markdown level1 conceptual"></div>
  1647. <h5 class="decalaration">Declaration</h5>
  1648. <div class="codewrapper">
  1649. <pre><code class="lang-csharp hljs">public void DrawHotString(ustring text, bool focused, ColorScheme scheme)</code></pre>
  1650. </div>
  1651. <h5 class="parameters">Parameters</h5>
  1652. <table class="table table-bordered table-striped table-condensed">
  1653. <thead>
  1654. <tr>
  1655. <th>Type</th>
  1656. <th>Name</th>
  1657. <th>Description</th>
  1658. </tr>
  1659. </thead>
  1660. <tbody>
  1661. <tr>
  1662. <td><span class="xref">NStack.ustring</span></td>
  1663. <td><span class="parametername">text</span></td>
  1664. <td>String to display, the underscoore before a letter flags the next letter as the hotkey.</td>
  1665. </tr>
  1666. <tr>
  1667. <td><span class="xref">System.Boolean</span></td>
  1668. <td><span class="parametername">focused</span></td>
  1669. <td>If set to <code>true</code> this uses the focused colors from the color scheme, otherwise the regular ones.</td>
  1670. </tr>
  1671. <tr>
  1672. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  1673. <td><span class="parametername">scheme</span></td>
  1674. <td>The color scheme to use.</td>
  1675. </tr>
  1676. </tbody>
  1677. </table>
  1678. <a id="Terminal_Gui_View_DrawHotString_" data-uid="Terminal.Gui.View.DrawHotString*"></a>
  1679. <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>
  1680. <div class="markdown level1 summary">
  1681. Utility function to draw strings that contain a hotkey.
  1682. </div>
  1683. <div class="markdown level1 conceptual"></div>
  1684. <h5 class="decalaration">Declaration</h5>
  1685. <div class="codewrapper">
  1686. <pre><code class="lang-csharp hljs">public void DrawHotString(ustring text, Attribute hotColor, Attribute normalColor)</code></pre>
  1687. </div>
  1688. <h5 class="parameters">Parameters</h5>
  1689. <table class="table table-bordered table-striped table-condensed">
  1690. <thead>
  1691. <tr>
  1692. <th>Type</th>
  1693. <th>Name</th>
  1694. <th>Description</th>
  1695. </tr>
  1696. </thead>
  1697. <tbody>
  1698. <tr>
  1699. <td><span class="xref">NStack.ustring</span></td>
  1700. <td><span class="parametername">text</span></td>
  1701. <td>String to display, the hotkey specifier before a letter flags the next letter as the hotkey.</td>
  1702. </tr>
  1703. <tr>
  1704. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  1705. <td><span class="parametername">hotColor</span></td>
  1706. <td>Hot color.</td>
  1707. </tr>
  1708. <tr>
  1709. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  1710. <td><span class="parametername">normalColor</span></td>
  1711. <td>Normal color.</td>
  1712. </tr>
  1713. </tbody>
  1714. </table>
  1715. <h5 id="Terminal_Gui_View_DrawHotString_NStack_ustring_Terminal_Gui_Attribute_Terminal_Gui_Attribute__remarks">Remarks</h5>
  1716. <div class="markdown level1 remarks">
  1717. <p>The hotkey is any character following the hotkey specifier, which is the underscore (&apos;_&apos;) character by default.</p>
  1718. <p>The hotkey specifier can be changed via <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">HotKeySpecifier</a></p>
  1719. </div>
  1720. <a id="Terminal_Gui_View_EndInit_" data-uid="Terminal.Gui.View.EndInit*"></a>
  1721. <h4 id="Terminal_Gui_View_EndInit" data-uid="Terminal.Gui.View.EndInit">EndInit()</h4>
  1722. <div class="markdown level1 summary">
  1723. This derived from <span class="xref">System.ComponentModel.ISupportInitializeNotification</span> to allow notify all the views that are ending initialized.
  1724. </div>
  1725. <div class="markdown level1 conceptual"></div>
  1726. <h5 class="decalaration">Declaration</h5>
  1727. <div class="codewrapper">
  1728. <pre><code class="lang-csharp hljs">public void EndInit()</code></pre>
  1729. </div>
  1730. <a id="Terminal_Gui_View_EnsureFocus_" data-uid="Terminal.Gui.View.EnsureFocus*"></a>
  1731. <h4 id="Terminal_Gui_View_EnsureFocus" data-uid="Terminal.Gui.View.EnsureFocus">EnsureFocus()</h4>
  1732. <div class="markdown level1 summary">
  1733. Finds the first view in the hierarchy that wants to get the focus if nothing is currently focused, otherwise, it does nothing.
  1734. </div>
  1735. <div class="markdown level1 conceptual"></div>
  1736. <h5 class="decalaration">Declaration</h5>
  1737. <div class="codewrapper">
  1738. <pre><code class="lang-csharp hljs">public void EnsureFocus()</code></pre>
  1739. </div>
  1740. <a id="Terminal_Gui_View_FocusFirst_" data-uid="Terminal.Gui.View.FocusFirst*"></a>
  1741. <h4 id="Terminal_Gui_View_FocusFirst" data-uid="Terminal.Gui.View.FocusFirst">FocusFirst()</h4>
  1742. <div class="markdown level1 summary">
  1743. Focuses the first focusable subview if one exists.
  1744. </div>
  1745. <div class="markdown level1 conceptual"></div>
  1746. <h5 class="decalaration">Declaration</h5>
  1747. <div class="codewrapper">
  1748. <pre><code class="lang-csharp hljs">public void FocusFirst()</code></pre>
  1749. </div>
  1750. <a id="Terminal_Gui_View_FocusLast_" data-uid="Terminal.Gui.View.FocusLast*"></a>
  1751. <h4 id="Terminal_Gui_View_FocusLast" data-uid="Terminal.Gui.View.FocusLast">FocusLast()</h4>
  1752. <div class="markdown level1 summary">
  1753. Focuses the last focusable subview if one exists.
  1754. </div>
  1755. <div class="markdown level1 conceptual"></div>
  1756. <h5 class="decalaration">Declaration</h5>
  1757. <div class="codewrapper">
  1758. <pre><code class="lang-csharp hljs">public void FocusLast()</code></pre>
  1759. </div>
  1760. <a id="Terminal_Gui_View_FocusNext_" data-uid="Terminal.Gui.View.FocusNext*"></a>
  1761. <h4 id="Terminal_Gui_View_FocusNext" data-uid="Terminal.Gui.View.FocusNext">FocusNext()</h4>
  1762. <div class="markdown level1 summary">
  1763. Focuses the next view.
  1764. </div>
  1765. <div class="markdown level1 conceptual"></div>
  1766. <h5 class="decalaration">Declaration</h5>
  1767. <div class="codewrapper">
  1768. <pre><code class="lang-csharp hljs">public bool FocusNext()</code></pre>
  1769. </div>
  1770. <h5 class="returns">Returns</h5>
  1771. <table class="table table-bordered table-striped table-condensed">
  1772. <thead>
  1773. <tr>
  1774. <th>Type</th>
  1775. <th>Description</th>
  1776. </tr>
  1777. </thead>
  1778. <tbody>
  1779. <tr>
  1780. <td><span class="xref">System.Boolean</span></td>
  1781. <td><code>true</code>, if next was focused, <code>false</code> otherwise.</td>
  1782. </tr>
  1783. </tbody>
  1784. </table>
  1785. <a id="Terminal_Gui_View_FocusPrev_" data-uid="Terminal.Gui.View.FocusPrev*"></a>
  1786. <h4 id="Terminal_Gui_View_FocusPrev" data-uid="Terminal.Gui.View.FocusPrev">FocusPrev()</h4>
  1787. <div class="markdown level1 summary">
  1788. Focuses the previous view.
  1789. </div>
  1790. <div class="markdown level1 conceptual"></div>
  1791. <h5 class="decalaration">Declaration</h5>
  1792. <div class="codewrapper">
  1793. <pre><code class="lang-csharp hljs">public bool FocusPrev()</code></pre>
  1794. </div>
  1795. <h5 class="returns">Returns</h5>
  1796. <table class="table table-bordered table-striped table-condensed">
  1797. <thead>
  1798. <tr>
  1799. <th>Type</th>
  1800. <th>Description</th>
  1801. </tr>
  1802. </thead>
  1803. <tbody>
  1804. <tr>
  1805. <td><span class="xref">System.Boolean</span></td>
  1806. <td><code>true</code>, if previous was focused, <code>false</code> otherwise.</td>
  1807. </tr>
  1808. </tbody>
  1809. </table>
  1810. <a id="Terminal_Gui_View_LayoutSubviews_" data-uid="Terminal.Gui.View.LayoutSubviews*"></a>
  1811. <h4 id="Terminal_Gui_View_LayoutSubviews" data-uid="Terminal.Gui.View.LayoutSubviews">LayoutSubviews()</h4>
  1812. <div class="markdown level1 summary">
  1813. Invoked when a view starts executing or when the dimensions of the view have changed, for example in
  1814. response to the container view or terminal resizing.
  1815. </div>
  1816. <div class="markdown level1 conceptual"></div>
  1817. <h5 class="decalaration">Declaration</h5>
  1818. <div class="codewrapper">
  1819. <pre><code class="lang-csharp hljs">public virtual void LayoutSubviews()</code></pre>
  1820. </div>
  1821. <h5 id="Terminal_Gui_View_LayoutSubviews_remarks">Remarks</h5>
  1822. <div class="markdown level1 remarks">
  1823. Calls <span class="xref">Terminal.Gui.View.OnLayoutComplete(Terminal.Gui.View.LayoutEventArgs)</span> (which raises the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">LayoutComplete</a> event) before it returns.
  1824. </div>
  1825. <a id="Terminal_Gui_View_Move_" data-uid="Terminal.Gui.View.Move*"></a>
  1826. <h4 id="Terminal_Gui_View_Move_System_Int32_System_Int32_" data-uid="Terminal.Gui.View.Move(System.Int32,System.Int32)">Move(Int32, Int32)</h4>
  1827. <div class="markdown level1 summary">
  1828. This moves the cursor to the specified column and row in the view.
  1829. </div>
  1830. <div class="markdown level1 conceptual"></div>
  1831. <h5 class="decalaration">Declaration</h5>
  1832. <div class="codewrapper">
  1833. <pre><code class="lang-csharp hljs">public void Move(int col, int row)</code></pre>
  1834. </div>
  1835. <h5 class="parameters">Parameters</h5>
  1836. <table class="table table-bordered table-striped table-condensed">
  1837. <thead>
  1838. <tr>
  1839. <th>Type</th>
  1840. <th>Name</th>
  1841. <th>Description</th>
  1842. </tr>
  1843. </thead>
  1844. <tbody>
  1845. <tr>
  1846. <td><span class="xref">System.Int32</span></td>
  1847. <td><span class="parametername">col</span></td>
  1848. <td>Col.</td>
  1849. </tr>
  1850. <tr>
  1851. <td><span class="xref">System.Int32</span></td>
  1852. <td><span class="parametername">row</span></td>
  1853. <td>Row.</td>
  1854. </tr>
  1855. </tbody>
  1856. </table>
  1857. <a id="Terminal_Gui_View_OnAdded_" data-uid="Terminal.Gui.View.OnAdded*"></a>
  1858. <h4 id="Terminal_Gui_View_OnAdded_Terminal_Gui_View_" data-uid="Terminal.Gui.View.OnAdded(Terminal.Gui.View)">OnAdded(View)</h4>
  1859. <div class="markdown level1 summary">
  1860. Method invoked when a subview is being added to this view.
  1861. </div>
  1862. <div class="markdown level1 conceptual"></div>
  1863. <h5 class="decalaration">Declaration</h5>
  1864. <div class="codewrapper">
  1865. <pre><code class="lang-csharp hljs">public virtual void OnAdded(View view)</code></pre>
  1866. </div>
  1867. <h5 class="parameters">Parameters</h5>
  1868. <table class="table table-bordered table-striped table-condensed">
  1869. <thead>
  1870. <tr>
  1871. <th>Type</th>
  1872. <th>Name</th>
  1873. <th>Description</th>
  1874. </tr>
  1875. </thead>
  1876. <tbody>
  1877. <tr>
  1878. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  1879. <td><span class="parametername">view</span></td>
  1880. <td>The subview being added.</td>
  1881. </tr>
  1882. </tbody>
  1883. </table>
  1884. <a id="Terminal_Gui_View_OnDrawContent_" data-uid="Terminal.Gui.View.OnDrawContent*"></a>
  1885. <h4 id="Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_" data-uid="Terminal.Gui.View.OnDrawContent(Terminal.Gui.Rect)">OnDrawContent(Rect)</h4>
  1886. <div class="markdown level1 summary">
  1887. Enables overrides to draw infinitely scrolled content and/or a background behind added controls.
  1888. </div>
  1889. <div class="markdown level1 conceptual"></div>
  1890. <h5 class="decalaration">Declaration</h5>
  1891. <div class="codewrapper">
  1892. <pre><code class="lang-csharp hljs">public virtual void OnDrawContent(Rect viewport)</code></pre>
  1893. </div>
  1894. <h5 class="parameters">Parameters</h5>
  1895. <table class="table table-bordered table-striped table-condensed">
  1896. <thead>
  1897. <tr>
  1898. <th>Type</th>
  1899. <th>Name</th>
  1900. <th>Description</th>
  1901. </tr>
  1902. </thead>
  1903. <tbody>
  1904. <tr>
  1905. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1906. <td><span class="parametername">viewport</span></td>
  1907. <td>The view-relative rectangle describing the currently visible viewport into the <a class="xref" href="Terminal.Gui.View.html">View</a></td>
  1908. </tr>
  1909. </tbody>
  1910. </table>
  1911. <h5 id="Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect__remarks">Remarks</h5>
  1912. <div class="markdown level1 remarks">
  1913. This method will be called before any subviews added with <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">Add(View)</a> have been drawn.
  1914. </div>
  1915. <a id="Terminal_Gui_View_OnEnter_" data-uid="Terminal.Gui.View.OnEnter*"></a>
  1916. <h4 id="Terminal_Gui_View_OnEnter_Terminal_Gui_View_" data-uid="Terminal.Gui.View.OnEnter(Terminal.Gui.View)">OnEnter(View)</h4>
  1917. <div class="markdown level1 summary">
  1918. Method invoked when a view gets focus.
  1919. </div>
  1920. <div class="markdown level1 conceptual"></div>
  1921. <h5 class="decalaration">Declaration</h5>
  1922. <div class="codewrapper">
  1923. <pre><code class="lang-csharp hljs">public override bool OnEnter(View view)</code></pre>
  1924. </div>
  1925. <h5 class="parameters">Parameters</h5>
  1926. <table class="table table-bordered table-striped table-condensed">
  1927. <thead>
  1928. <tr>
  1929. <th>Type</th>
  1930. <th>Name</th>
  1931. <th>Description</th>
  1932. </tr>
  1933. </thead>
  1934. <tbody>
  1935. <tr>
  1936. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  1937. <td><span class="parametername">view</span></td>
  1938. <td>The view that is losing focus.</td>
  1939. </tr>
  1940. </tbody>
  1941. </table>
  1942. <h5 class="returns">Returns</h5>
  1943. <table class="table table-bordered table-striped table-condensed">
  1944. <thead>
  1945. <tr>
  1946. <th>Type</th>
  1947. <th>Description</th>
  1948. </tr>
  1949. </thead>
  1950. <tbody>
  1951. <tr>
  1952. <td><span class="xref">System.Boolean</span></td>
  1953. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  1954. </tr>
  1955. </tbody>
  1956. </table>
  1957. <h5 class="overrides">Overrides</h5>
  1958. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_OnEnter_Terminal_Gui_View_">Responder.OnEnter(View)</a></div>
  1959. <a id="Terminal_Gui_View_OnKeyDown_" data-uid="Terminal.Gui.View.OnKeyDown*"></a>
  1960. <h4 id="Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.View.OnKeyDown(Terminal.Gui.KeyEvent)">OnKeyDown(KeyEvent)</h4>
  1961. <div class="markdown level1 summary"></div>
  1962. <div class="markdown level1 conceptual"></div>
  1963. <h5 class="decalaration">Declaration</h5>
  1964. <div class="codewrapper">
  1965. <pre><code class="lang-csharp hljs">public override bool OnKeyDown(KeyEvent keyEvent)</code></pre>
  1966. </div>
  1967. <h5 class="parameters">Parameters</h5>
  1968. <table class="table table-bordered table-striped table-condensed">
  1969. <thead>
  1970. <tr>
  1971. <th>Type</th>
  1972. <th>Name</th>
  1973. <th>Description</th>
  1974. </tr>
  1975. </thead>
  1976. <tbody>
  1977. <tr>
  1978. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  1979. <td><span class="parametername">keyEvent</span></td>
  1980. <td>Contains the details about the key that produced the event.</td>
  1981. </tr>
  1982. </tbody>
  1983. </table>
  1984. <h5 class="returns">Returns</h5>
  1985. <table class="table table-bordered table-striped table-condensed">
  1986. <thead>
  1987. <tr>
  1988. <th>Type</th>
  1989. <th>Description</th>
  1990. </tr>
  1991. </thead>
  1992. <tbody>
  1993. <tr>
  1994. <td><span class="xref">System.Boolean</span></td>
  1995. <td></td>
  1996. </tr>
  1997. </tbody>
  1998. </table>
  1999. <h5 class="overrides">Overrides</h5>
  2000. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_OnKeyDown_Terminal_Gui_KeyEvent_">Responder.OnKeyDown(KeyEvent)</a></div>
  2001. <a id="Terminal_Gui_View_OnKeyUp_" data-uid="Terminal.Gui.View.OnKeyUp*"></a>
  2002. <h4 id="Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.View.OnKeyUp(Terminal.Gui.KeyEvent)">OnKeyUp(KeyEvent)</h4>
  2003. <div class="markdown level1 summary"></div>
  2004. <div class="markdown level1 conceptual"></div>
  2005. <h5 class="decalaration">Declaration</h5>
  2006. <div class="codewrapper">
  2007. <pre><code class="lang-csharp hljs">public override bool OnKeyUp(KeyEvent keyEvent)</code></pre>
  2008. </div>
  2009. <h5 class="parameters">Parameters</h5>
  2010. <table class="table table-bordered table-striped table-condensed">
  2011. <thead>
  2012. <tr>
  2013. <th>Type</th>
  2014. <th>Name</th>
  2015. <th>Description</th>
  2016. </tr>
  2017. </thead>
  2018. <tbody>
  2019. <tr>
  2020. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  2021. <td><span class="parametername">keyEvent</span></td>
  2022. <td>Contains the details about the key that produced the event.</td>
  2023. </tr>
  2024. </tbody>
  2025. </table>
  2026. <h5 class="returns">Returns</h5>
  2027. <table class="table table-bordered table-striped table-condensed">
  2028. <thead>
  2029. <tr>
  2030. <th>Type</th>
  2031. <th>Description</th>
  2032. </tr>
  2033. </thead>
  2034. <tbody>
  2035. <tr>
  2036. <td><span class="xref">System.Boolean</span></td>
  2037. <td></td>
  2038. </tr>
  2039. </tbody>
  2040. </table>
  2041. <h5 class="overrides">Overrides</h5>
  2042. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_OnKeyUp_Terminal_Gui_KeyEvent_">Responder.OnKeyUp(KeyEvent)</a></div>
  2043. <a id="Terminal_Gui_View_OnLeave_" data-uid="Terminal.Gui.View.OnLeave*"></a>
  2044. <h4 id="Terminal_Gui_View_OnLeave_Terminal_Gui_View_" data-uid="Terminal.Gui.View.OnLeave(Terminal.Gui.View)">OnLeave(View)</h4>
  2045. <div class="markdown level1 summary">
  2046. Method invoked when a view loses focus.
  2047. </div>
  2048. <div class="markdown level1 conceptual"></div>
  2049. <h5 class="decalaration">Declaration</h5>
  2050. <div class="codewrapper">
  2051. <pre><code class="lang-csharp hljs">public override bool OnLeave(View view)</code></pre>
  2052. </div>
  2053. <h5 class="parameters">Parameters</h5>
  2054. <table class="table table-bordered table-striped table-condensed">
  2055. <thead>
  2056. <tr>
  2057. <th>Type</th>
  2058. <th>Name</th>
  2059. <th>Description</th>
  2060. </tr>
  2061. </thead>
  2062. <tbody>
  2063. <tr>
  2064. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  2065. <td><span class="parametername">view</span></td>
  2066. <td>The view that is getting focus.</td>
  2067. </tr>
  2068. </tbody>
  2069. </table>
  2070. <h5 class="returns">Returns</h5>
  2071. <table class="table table-bordered table-striped table-condensed">
  2072. <thead>
  2073. <tr>
  2074. <th>Type</th>
  2075. <th>Description</th>
  2076. </tr>
  2077. </thead>
  2078. <tbody>
  2079. <tr>
  2080. <td><span class="xref">System.Boolean</span></td>
  2081. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  2082. </tr>
  2083. </tbody>
  2084. </table>
  2085. <h5 class="overrides">Overrides</h5>
  2086. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_OnLeave_Terminal_Gui_View_">Responder.OnLeave(View)</a></div>
  2087. <a id="Terminal_Gui_View_OnMouseClick_" data-uid="Terminal.Gui.View.OnMouseClick*"></a>
  2088. <h4 id="Terminal_Gui_View_OnMouseClick_Terminal_Gui_View_MouseEventArgs_" data-uid="Terminal.Gui.View.OnMouseClick(Terminal.Gui.View.MouseEventArgs)">OnMouseClick(View.MouseEventArgs)</h4>
  2089. <div class="markdown level1 summary">
  2090. Invokes the MouseClick event.
  2091. </div>
  2092. <div class="markdown level1 conceptual"></div>
  2093. <h5 class="decalaration">Declaration</h5>
  2094. <div class="codewrapper">
  2095. <pre><code class="lang-csharp hljs">protected void OnMouseClick(View.MouseEventArgs args)</code></pre>
  2096. </div>
  2097. <h5 class="parameters">Parameters</h5>
  2098. <table class="table table-bordered table-striped table-condensed">
  2099. <thead>
  2100. <tr>
  2101. <th>Type</th>
  2102. <th>Name</th>
  2103. <th>Description</th>
  2104. </tr>
  2105. </thead>
  2106. <tbody>
  2107. <tr>
  2108. <td><a class="xref" href="Terminal.Gui.View.MouseEventArgs.html">View.MouseEventArgs</a></td>
  2109. <td><span class="parametername">args</span></td>
  2110. <td></td>
  2111. </tr>
  2112. </tbody>
  2113. </table>
  2114. <a id="Terminal_Gui_View_OnMouseEnter_" data-uid="Terminal.Gui.View.OnMouseEnter*"></a>
  2115. <h4 id="Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.View.OnMouseEnter(Terminal.Gui.MouseEvent)">OnMouseEnter(MouseEvent)</h4>
  2116. <div class="markdown level1 summary">
  2117. Method invoked when a mouse event is generated for the first time.
  2118. </div>
  2119. <div class="markdown level1 conceptual"></div>
  2120. <h5 class="decalaration">Declaration</h5>
  2121. <div class="codewrapper">
  2122. <pre><code class="lang-csharp hljs">public override bool OnMouseEnter(MouseEvent mouseEvent)</code></pre>
  2123. </div>
  2124. <h5 class="parameters">Parameters</h5>
  2125. <table class="table table-bordered table-striped table-condensed">
  2126. <thead>
  2127. <tr>
  2128. <th>Type</th>
  2129. <th>Name</th>
  2130. <th>Description</th>
  2131. </tr>
  2132. </thead>
  2133. <tbody>
  2134. <tr>
  2135. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  2136. <td><span class="parametername">mouseEvent</span></td>
  2137. <td></td>
  2138. </tr>
  2139. </tbody>
  2140. </table>
  2141. <h5 class="returns">Returns</h5>
  2142. <table class="table table-bordered table-striped table-condensed">
  2143. <thead>
  2144. <tr>
  2145. <th>Type</th>
  2146. <th>Description</th>
  2147. </tr>
  2148. </thead>
  2149. <tbody>
  2150. <tr>
  2151. <td><span class="xref">System.Boolean</span></td>
  2152. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  2153. </tr>
  2154. </tbody>
  2155. </table>
  2156. <h5 class="overrides">Overrides</h5>
  2157. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_OnMouseEnter_Terminal_Gui_MouseEvent_">Responder.OnMouseEnter(MouseEvent)</a></div>
  2158. <a id="Terminal_Gui_View_OnMouseEvent_" data-uid="Terminal.Gui.View.OnMouseEvent*"></a>
  2159. <h4 id="Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.View.OnMouseEvent(Terminal.Gui.MouseEvent)">OnMouseEvent(MouseEvent)</h4>
  2160. <div class="markdown level1 summary">
  2161. Method invoked when a mouse event is generated
  2162. </div>
  2163. <div class="markdown level1 conceptual"></div>
  2164. <h5 class="decalaration">Declaration</h5>
  2165. <div class="codewrapper">
  2166. <pre><code class="lang-csharp hljs">public virtual bool OnMouseEvent(MouseEvent mouseEvent)</code></pre>
  2167. </div>
  2168. <h5 class="parameters">Parameters</h5>
  2169. <table class="table table-bordered table-striped table-condensed">
  2170. <thead>
  2171. <tr>
  2172. <th>Type</th>
  2173. <th>Name</th>
  2174. <th>Description</th>
  2175. </tr>
  2176. </thead>
  2177. <tbody>
  2178. <tr>
  2179. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  2180. <td><span class="parametername">mouseEvent</span></td>
  2181. <td></td>
  2182. </tr>
  2183. </tbody>
  2184. </table>
  2185. <h5 class="returns">Returns</h5>
  2186. <table class="table table-bordered table-striped table-condensed">
  2187. <thead>
  2188. <tr>
  2189. <th>Type</th>
  2190. <th>Description</th>
  2191. </tr>
  2192. </thead>
  2193. <tbody>
  2194. <tr>
  2195. <td><span class="xref">System.Boolean</span></td>
  2196. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  2197. </tr>
  2198. </tbody>
  2199. </table>
  2200. <a id="Terminal_Gui_View_OnMouseLeave_" data-uid="Terminal.Gui.View.OnMouseLeave*"></a>
  2201. <h4 id="Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.View.OnMouseLeave(Terminal.Gui.MouseEvent)">OnMouseLeave(MouseEvent)</h4>
  2202. <div class="markdown level1 summary">
  2203. Method invoked when a mouse event is generated for the last time.
  2204. </div>
  2205. <div class="markdown level1 conceptual"></div>
  2206. <h5 class="decalaration">Declaration</h5>
  2207. <div class="codewrapper">
  2208. <pre><code class="lang-csharp hljs">public override bool OnMouseLeave(MouseEvent mouseEvent)</code></pre>
  2209. </div>
  2210. <h5 class="parameters">Parameters</h5>
  2211. <table class="table table-bordered table-striped table-condensed">
  2212. <thead>
  2213. <tr>
  2214. <th>Type</th>
  2215. <th>Name</th>
  2216. <th>Description</th>
  2217. </tr>
  2218. </thead>
  2219. <tbody>
  2220. <tr>
  2221. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  2222. <td><span class="parametername">mouseEvent</span></td>
  2223. <td></td>
  2224. </tr>
  2225. </tbody>
  2226. </table>
  2227. <h5 class="returns">Returns</h5>
  2228. <table class="table table-bordered table-striped table-condensed">
  2229. <thead>
  2230. <tr>
  2231. <th>Type</th>
  2232. <th>Description</th>
  2233. </tr>
  2234. </thead>
  2235. <tbody>
  2236. <tr>
  2237. <td><span class="xref">System.Boolean</span></td>
  2238. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  2239. </tr>
  2240. </tbody>
  2241. </table>
  2242. <h5 class="overrides">Overrides</h5>
  2243. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_OnMouseLeave_Terminal_Gui_MouseEvent_">Responder.OnMouseLeave(MouseEvent)</a></div>
  2244. <a id="Terminal_Gui_View_OnRemoved_" data-uid="Terminal.Gui.View.OnRemoved*"></a>
  2245. <h4 id="Terminal_Gui_View_OnRemoved_Terminal_Gui_View_" data-uid="Terminal.Gui.View.OnRemoved(Terminal.Gui.View)">OnRemoved(View)</h4>
  2246. <div class="markdown level1 summary">
  2247. Method invoked when a subview is being removed from this view.
  2248. </div>
  2249. <div class="markdown level1 conceptual"></div>
  2250. <h5 class="decalaration">Declaration</h5>
  2251. <div class="codewrapper">
  2252. <pre><code class="lang-csharp hljs">public virtual void OnRemoved(View view)</code></pre>
  2253. </div>
  2254. <h5 class="parameters">Parameters</h5>
  2255. <table class="table table-bordered table-striped table-condensed">
  2256. <thead>
  2257. <tr>
  2258. <th>Type</th>
  2259. <th>Name</th>
  2260. <th>Description</th>
  2261. </tr>
  2262. </thead>
  2263. <tbody>
  2264. <tr>
  2265. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  2266. <td><span class="parametername">view</span></td>
  2267. <td>The subview being removed.</td>
  2268. </tr>
  2269. </tbody>
  2270. </table>
  2271. <a id="Terminal_Gui_View_PositionCursor_" data-uid="Terminal.Gui.View.PositionCursor*"></a>
  2272. <h4 id="Terminal_Gui_View_PositionCursor" data-uid="Terminal.Gui.View.PositionCursor">PositionCursor()</h4>
  2273. <div class="markdown level1 summary">
  2274. Positions the cursor in the right position based on the currently focused view in the chain.
  2275. </div>
  2276. <div class="markdown level1 conceptual"></div>
  2277. <h5 class="decalaration">Declaration</h5>
  2278. <div class="codewrapper">
  2279. <pre><code class="lang-csharp hljs">public virtual void PositionCursor()</code></pre>
  2280. </div>
  2281. <a id="Terminal_Gui_View_ProcessColdKey_" data-uid="Terminal.Gui.View.ProcessColdKey*"></a>
  2282. <h4 id="Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.View.ProcessColdKey(Terminal.Gui.KeyEvent)">ProcessColdKey(KeyEvent)</h4>
  2283. <div class="markdown level1 summary">
  2284. This method can be overwritten by views that
  2285. want to provide accelerator functionality
  2286. (Alt-key for example), but without
  2287. interefering with normal ProcessKey behavior.
  2288. </div>
  2289. <div class="markdown level1 conceptual"></div>
  2290. <h5 class="decalaration">Declaration</h5>
  2291. <div class="codewrapper">
  2292. <pre><code class="lang-csharp hljs">public override bool ProcessColdKey(KeyEvent keyEvent)</code></pre>
  2293. </div>
  2294. <h5 class="parameters">Parameters</h5>
  2295. <table class="table table-bordered table-striped table-condensed">
  2296. <thead>
  2297. <tr>
  2298. <th>Type</th>
  2299. <th>Name</th>
  2300. <th>Description</th>
  2301. </tr>
  2302. </thead>
  2303. <tbody>
  2304. <tr>
  2305. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  2306. <td><span class="parametername">keyEvent</span></td>
  2307. <td>Contains the details about the key that produced the event.</td>
  2308. </tr>
  2309. </tbody>
  2310. </table>
  2311. <h5 class="returns">Returns</h5>
  2312. <table class="table table-bordered table-striped table-condensed">
  2313. <thead>
  2314. <tr>
  2315. <th>Type</th>
  2316. <th>Description</th>
  2317. </tr>
  2318. </thead>
  2319. <tbody>
  2320. <tr>
  2321. <td><span class="xref">System.Boolean</span></td>
  2322. <td></td>
  2323. </tr>
  2324. </tbody>
  2325. </table>
  2326. <h5 class="overrides">Overrides</h5>
  2327. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_ProcessColdKey_Terminal_Gui_KeyEvent_">Responder.ProcessColdKey(KeyEvent)</a></div>
  2328. <h5 id="Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
  2329. <div class="markdown level1 remarks">
  2330. <p>
  2331. After keys are sent to the subviews on the
  2332. current view, all the view are
  2333. processed and the key is passed to the views
  2334. to allow some of them to process the keystroke
  2335. as a cold-key. </p>
  2336. <p>
  2337. This functionality is used, for example, by
  2338. default buttons to act on the enter key.
  2339. Processing this as a hot-key would prevent
  2340. non-default buttons from consuming the enter
  2341. keypress when they have the focus.
  2342. </p>
  2343. </div>
  2344. <a id="Terminal_Gui_View_ProcessHotKey_" data-uid="Terminal.Gui.View.ProcessHotKey*"></a>
  2345. <h4 id="Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.View.ProcessHotKey(Terminal.Gui.KeyEvent)">ProcessHotKey(KeyEvent)</h4>
  2346. <div class="markdown level1 summary">
  2347. This method can be overwritten by view that
  2348. want to provide accelerator functionality
  2349. (Alt-key for example).
  2350. </div>
  2351. <div class="markdown level1 conceptual"></div>
  2352. <h5 class="decalaration">Declaration</h5>
  2353. <div class="codewrapper">
  2354. <pre><code class="lang-csharp hljs">public override bool ProcessHotKey(KeyEvent keyEvent)</code></pre>
  2355. </div>
  2356. <h5 class="parameters">Parameters</h5>
  2357. <table class="table table-bordered table-striped table-condensed">
  2358. <thead>
  2359. <tr>
  2360. <th>Type</th>
  2361. <th>Name</th>
  2362. <th>Description</th>
  2363. </tr>
  2364. </thead>
  2365. <tbody>
  2366. <tr>
  2367. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  2368. <td><span class="parametername">keyEvent</span></td>
  2369. <td></td>
  2370. </tr>
  2371. </tbody>
  2372. </table>
  2373. <h5 class="returns">Returns</h5>
  2374. <table class="table table-bordered table-striped table-condensed">
  2375. <thead>
  2376. <tr>
  2377. <th>Type</th>
  2378. <th>Description</th>
  2379. </tr>
  2380. </thead>
  2381. <tbody>
  2382. <tr>
  2383. <td><span class="xref">System.Boolean</span></td>
  2384. <td></td>
  2385. </tr>
  2386. </tbody>
  2387. </table>
  2388. <h5 class="overrides">Overrides</h5>
  2389. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_ProcessHotKey_Terminal_Gui_KeyEvent_">Responder.ProcessHotKey(KeyEvent)</a></div>
  2390. <h5 id="Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
  2391. <div class="markdown level1 remarks">
  2392. <p>
  2393. Before keys are sent to the subview on the
  2394. current view, all the views are
  2395. processed and the key is passed to the widgets
  2396. to allow some of them to process the keystroke
  2397. as a hot-key. </p>
  2398. <p>
  2399. For example, if you implement a button that
  2400. has a hotkey ok &quot;o&quot;, you would catch the
  2401. combination Alt-o here. If the event is
  2402. caught, you must return true to stop the
  2403. keystroke from being dispatched to other
  2404. views.
  2405. </p>
  2406. </div>
  2407. <a id="Terminal_Gui_View_ProcessKey_" data-uid="Terminal.Gui.View.ProcessKey*"></a>
  2408. <h4 id="Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.View.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  2409. <div class="markdown level1 summary">
  2410. If the view is focused, gives the view a
  2411. chance to process the keystroke.
  2412. </div>
  2413. <div class="markdown level1 conceptual"></div>
  2414. <h5 class="decalaration">Declaration</h5>
  2415. <div class="codewrapper">
  2416. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent keyEvent)</code></pre>
  2417. </div>
  2418. <h5 class="parameters">Parameters</h5>
  2419. <table class="table table-bordered table-striped table-condensed">
  2420. <thead>
  2421. <tr>
  2422. <th>Type</th>
  2423. <th>Name</th>
  2424. <th>Description</th>
  2425. </tr>
  2426. </thead>
  2427. <tbody>
  2428. <tr>
  2429. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  2430. <td><span class="parametername">keyEvent</span></td>
  2431. <td>Contains the details about the key that produced the event.</td>
  2432. </tr>
  2433. </tbody>
  2434. </table>
  2435. <h5 class="returns">Returns</h5>
  2436. <table class="table table-bordered table-striped table-condensed">
  2437. <thead>
  2438. <tr>
  2439. <th>Type</th>
  2440. <th>Description</th>
  2441. </tr>
  2442. </thead>
  2443. <tbody>
  2444. <tr>
  2445. <td><span class="xref">System.Boolean</span></td>
  2446. <td></td>
  2447. </tr>
  2448. </tbody>
  2449. </table>
  2450. <h5 class="overrides">Overrides</h5>
  2451. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_ProcessKey_Terminal_Gui_KeyEvent_">Responder.ProcessKey(KeyEvent)</a></div>
  2452. <h5 id="Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
  2453. <div class="markdown level1 remarks">
  2454. <p>
  2455. Views can override this method if they are
  2456. interested in processing the given keystroke.
  2457. If they consume the keystroke, they must
  2458. return true to stop the keystroke from being
  2459. processed by other widgets or consumed by the
  2460. widget engine. If they return false, the
  2461. keystroke will be passed using the ProcessColdKey
  2462. method to other views to process.
  2463. </p>
  2464. <p>
  2465. The View implementation does nothing but return false,
  2466. so it is not necessary to call base.ProcessKey if you
  2467. derive directly from View, but you should if you derive
  2468. other View subclasses.
  2469. </p>
  2470. </div>
  2471. <a id="Terminal_Gui_View_Redraw_" data-uid="Terminal.Gui.View.Redraw*"></a>
  2472. <h4 id="Terminal_Gui_View_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.View.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  2473. <div class="markdown level1 summary">
  2474. Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
  2475. </div>
  2476. <div class="markdown level1 conceptual"></div>
  2477. <h5 class="decalaration">Declaration</h5>
  2478. <div class="codewrapper">
  2479. <pre><code class="lang-csharp hljs">public virtual void Redraw(Rect bounds)</code></pre>
  2480. </div>
  2481. <h5 class="parameters">Parameters</h5>
  2482. <table class="table table-bordered table-striped table-condensed">
  2483. <thead>
  2484. <tr>
  2485. <th>Type</th>
  2486. <th>Name</th>
  2487. <th>Description</th>
  2488. </tr>
  2489. </thead>
  2490. <tbody>
  2491. <tr>
  2492. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  2493. <td><span class="parametername">bounds</span></td>
  2494. <td>The bounds (view-relative region) to redraw.</td>
  2495. </tr>
  2496. </tbody>
  2497. </table>
  2498. <h5 id="Terminal_Gui_View_Redraw_Terminal_Gui_Rect__remarks">Remarks</h5>
  2499. <div class="markdown level1 remarks">
  2500. <p>
  2501. Always use <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">Bounds</a> (view-relative) when calling <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">Redraw(Rect)</a>, NOT <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> (superview-relative).
  2502. </p>
  2503. <p>
  2504. Views should set the color that they want to use on entry, as otherwise this will inherit
  2505. the last color that was set globally on the driver.
  2506. </p>
  2507. <p>
  2508. Overrides of <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">Redraw(Rect)</a> must ensure they do not set <code>Driver.Clip</code> to a clip region
  2509. larger than the <code>region</code> parameter.
  2510. </p>
  2511. </div>
  2512. <a id="Terminal_Gui_View_Remove_" data-uid="Terminal.Gui.View.Remove*"></a>
  2513. <h4 id="Terminal_Gui_View_Remove_Terminal_Gui_View_" data-uid="Terminal.Gui.View.Remove(Terminal.Gui.View)">Remove(View)</h4>
  2514. <div class="markdown level1 summary">
  2515. Removes a subview added via <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">Add(View)</a> or <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">Add(View[])</a> from this View.
  2516. </div>
  2517. <div class="markdown level1 conceptual"></div>
  2518. <h5 class="decalaration">Declaration</h5>
  2519. <div class="codewrapper">
  2520. <pre><code class="lang-csharp hljs">public virtual void Remove(View view)</code></pre>
  2521. </div>
  2522. <h5 class="parameters">Parameters</h5>
  2523. <table class="table table-bordered table-striped table-condensed">
  2524. <thead>
  2525. <tr>
  2526. <th>Type</th>
  2527. <th>Name</th>
  2528. <th>Description</th>
  2529. </tr>
  2530. </thead>
  2531. <tbody>
  2532. <tr>
  2533. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  2534. <td><span class="parametername">view</span></td>
  2535. <td></td>
  2536. </tr>
  2537. </tbody>
  2538. </table>
  2539. <h5 id="Terminal_Gui_View_Remove_Terminal_Gui_View__remarks">Remarks</h5>
  2540. <div class="markdown level1 remarks">
  2541. </div>
  2542. <a id="Terminal_Gui_View_RemoveAll_" data-uid="Terminal.Gui.View.RemoveAll*"></a>
  2543. <h4 id="Terminal_Gui_View_RemoveAll" data-uid="Terminal.Gui.View.RemoveAll">RemoveAll()</h4>
  2544. <div class="markdown level1 summary">
  2545. Removes all subviews (children) added via <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">Add(View)</a> or <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">Add(View[])</a> from this View.
  2546. </div>
  2547. <div class="markdown level1 conceptual"></div>
  2548. <h5 class="decalaration">Declaration</h5>
  2549. <div class="codewrapper">
  2550. <pre><code class="lang-csharp hljs">public virtual void RemoveAll()</code></pre>
  2551. </div>
  2552. <a id="Terminal_Gui_View_ScreenToView_" data-uid="Terminal.Gui.View.ScreenToView*"></a>
  2553. <h4 id="Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_" data-uid="Terminal.Gui.View.ScreenToView(System.Int32,System.Int32)">ScreenToView(Int32, Int32)</h4>
  2554. <div class="markdown level1 summary">
  2555. Converts a point from screen-relative coordinates to view-relative coordinates.
  2556. </div>
  2557. <div class="markdown level1 conceptual"></div>
  2558. <h5 class="decalaration">Declaration</h5>
  2559. <div class="codewrapper">
  2560. <pre><code class="lang-csharp hljs">public Point ScreenToView(int x, int y)</code></pre>
  2561. </div>
  2562. <h5 class="parameters">Parameters</h5>
  2563. <table class="table table-bordered table-striped table-condensed">
  2564. <thead>
  2565. <tr>
  2566. <th>Type</th>
  2567. <th>Name</th>
  2568. <th>Description</th>
  2569. </tr>
  2570. </thead>
  2571. <tbody>
  2572. <tr>
  2573. <td><span class="xref">System.Int32</span></td>
  2574. <td><span class="parametername">x</span></td>
  2575. <td>X screen-coordinate point.</td>
  2576. </tr>
  2577. <tr>
  2578. <td><span class="xref">System.Int32</span></td>
  2579. <td><span class="parametername">y</span></td>
  2580. <td>Y screen-coordinate point.</td>
  2581. </tr>
  2582. </tbody>
  2583. </table>
  2584. <h5 class="returns">Returns</h5>
  2585. <table class="table table-bordered table-striped table-condensed">
  2586. <thead>
  2587. <tr>
  2588. <th>Type</th>
  2589. <th>Description</th>
  2590. </tr>
  2591. </thead>
  2592. <tbody>
  2593. <tr>
  2594. <td><a class="xref" href="Terminal.Gui.Point.html">Point</a></td>
  2595. <td>The mapped point.</td>
  2596. </tr>
  2597. </tbody>
  2598. </table>
  2599. <a id="Terminal_Gui_View_SendSubviewBackwards_" data-uid="Terminal.Gui.View.SendSubviewBackwards*"></a>
  2600. <h4 id="Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_" data-uid="Terminal.Gui.View.SendSubviewBackwards(Terminal.Gui.View)">SendSubviewBackwards(View)</h4>
  2601. <div class="markdown level1 summary">
  2602. Moves the subview backwards in the hierarchy, only one step
  2603. </div>
  2604. <div class="markdown level1 conceptual"></div>
  2605. <h5 class="decalaration">Declaration</h5>
  2606. <div class="codewrapper">
  2607. <pre><code class="lang-csharp hljs">public void SendSubviewBackwards(View subview)</code></pre>
  2608. </div>
  2609. <h5 class="parameters">Parameters</h5>
  2610. <table class="table table-bordered table-striped table-condensed">
  2611. <thead>
  2612. <tr>
  2613. <th>Type</th>
  2614. <th>Name</th>
  2615. <th>Description</th>
  2616. </tr>
  2617. </thead>
  2618. <tbody>
  2619. <tr>
  2620. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  2621. <td><span class="parametername">subview</span></td>
  2622. <td>The subview to send backwards</td>
  2623. </tr>
  2624. </tbody>
  2625. </table>
  2626. <h5 id="Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View__remarks">Remarks</h5>
  2627. <div class="markdown level1 remarks">
  2628. If you want to send the view all the way to the back use SendSubviewToBack.
  2629. </div>
  2630. <a id="Terminal_Gui_View_SendSubviewToBack_" data-uid="Terminal.Gui.View.SendSubviewToBack*"></a>
  2631. <h4 id="Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_" data-uid="Terminal.Gui.View.SendSubviewToBack(Terminal.Gui.View)">SendSubviewToBack(View)</h4>
  2632. <div class="markdown level1 summary">
  2633. Sends the specified subview to the front so it is the first view drawn
  2634. </div>
  2635. <div class="markdown level1 conceptual"></div>
  2636. <h5 class="decalaration">Declaration</h5>
  2637. <div class="codewrapper">
  2638. <pre><code class="lang-csharp hljs">public void SendSubviewToBack(View subview)</code></pre>
  2639. </div>
  2640. <h5 class="parameters">Parameters</h5>
  2641. <table class="table table-bordered table-striped table-condensed">
  2642. <thead>
  2643. <tr>
  2644. <th>Type</th>
  2645. <th>Name</th>
  2646. <th>Description</th>
  2647. </tr>
  2648. </thead>
  2649. <tbody>
  2650. <tr>
  2651. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  2652. <td><span class="parametername">subview</span></td>
  2653. <td>The subview to send to the front</td>
  2654. </tr>
  2655. </tbody>
  2656. </table>
  2657. <h5 id="Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View__remarks">Remarks</h5>
  2658. <div class="markdown level1 remarks">
  2659. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">BringSubviewToFront(View)</a>.
  2660. </div>
  2661. <a id="Terminal_Gui_View_SetChildNeedsDisplay_" data-uid="Terminal.Gui.View.SetChildNeedsDisplay*"></a>
  2662. <h4 id="Terminal_Gui_View_SetChildNeedsDisplay" data-uid="Terminal.Gui.View.SetChildNeedsDisplay">SetChildNeedsDisplay()</h4>
  2663. <div class="markdown level1 summary">
  2664. Indicates that any child views (in the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">Subviews</a> list) need to be repainted.
  2665. </div>
  2666. <div class="markdown level1 conceptual"></div>
  2667. <h5 class="decalaration">Declaration</h5>
  2668. <div class="codewrapper">
  2669. <pre><code class="lang-csharp hljs">public void SetChildNeedsDisplay()</code></pre>
  2670. </div>
  2671. <a id="Terminal_Gui_View_SetClip_" data-uid="Terminal.Gui.View.SetClip*"></a>
  2672. <h4 id="Terminal_Gui_View_SetClip_Terminal_Gui_Rect_" data-uid="Terminal.Gui.View.SetClip(Terminal.Gui.Rect)">SetClip(Rect)</h4>
  2673. <div class="markdown level1 summary">
  2674. Sets the clip region to the specified view-relative region.
  2675. </div>
  2676. <div class="markdown level1 conceptual"></div>
  2677. <h5 class="decalaration">Declaration</h5>
  2678. <div class="codewrapper">
  2679. <pre><code class="lang-csharp hljs">public Rect SetClip(Rect region)</code></pre>
  2680. </div>
  2681. <h5 class="parameters">Parameters</h5>
  2682. <table class="table table-bordered table-striped table-condensed">
  2683. <thead>
  2684. <tr>
  2685. <th>Type</th>
  2686. <th>Name</th>
  2687. <th>Description</th>
  2688. </tr>
  2689. </thead>
  2690. <tbody>
  2691. <tr>
  2692. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  2693. <td><span class="parametername">region</span></td>
  2694. <td>View-relative clip region.</td>
  2695. </tr>
  2696. </tbody>
  2697. </table>
  2698. <h5 class="returns">Returns</h5>
  2699. <table class="table table-bordered table-striped table-condensed">
  2700. <thead>
  2701. <tr>
  2702. <th>Type</th>
  2703. <th>Description</th>
  2704. </tr>
  2705. </thead>
  2706. <tbody>
  2707. <tr>
  2708. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  2709. <td>The previous screen-relative clip region.</td>
  2710. </tr>
  2711. </tbody>
  2712. </table>
  2713. <a id="Terminal_Gui_View_SetFocus_" data-uid="Terminal.Gui.View.SetFocus*"></a>
  2714. <h4 id="Terminal_Gui_View_SetFocus" data-uid="Terminal.Gui.View.SetFocus">SetFocus()</h4>
  2715. <div class="markdown level1 summary">
  2716. Causes the specified view and the entire parent hierarchy to have the focused order updated.
  2717. </div>
  2718. <div class="markdown level1 conceptual"></div>
  2719. <h5 class="decalaration">Declaration</h5>
  2720. <div class="codewrapper">
  2721. <pre><code class="lang-csharp hljs">public void SetFocus()</code></pre>
  2722. </div>
  2723. <a id="Terminal_Gui_View_SetHeight_" data-uid="Terminal.Gui.View.SetHeight*"></a>
  2724. <h4 id="Terminal_Gui_View_SetHeight_System_Int32_System_Int32__" data-uid="Terminal.Gui.View.SetHeight(System.Int32,System.Int32@)">SetHeight(Int32, out Int32)</h4>
  2725. <div class="markdown level1 summary">
  2726. Calculate the height based on the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">Height</a> settings.
  2727. </div>
  2728. <div class="markdown level1 conceptual"></div>
  2729. <h5 class="decalaration">Declaration</h5>
  2730. <div class="codewrapper">
  2731. <pre><code class="lang-csharp hljs">public bool SetHeight(int desiredHeight, out int resultHeight)</code></pre>
  2732. </div>
  2733. <h5 class="parameters">Parameters</h5>
  2734. <table class="table table-bordered table-striped table-condensed">
  2735. <thead>
  2736. <tr>
  2737. <th>Type</th>
  2738. <th>Name</th>
  2739. <th>Description</th>
  2740. </tr>
  2741. </thead>
  2742. <tbody>
  2743. <tr>
  2744. <td><span class="xref">System.Int32</span></td>
  2745. <td><span class="parametername">desiredHeight</span></td>
  2746. <td>The desired height.</td>
  2747. </tr>
  2748. <tr>
  2749. <td><span class="xref">System.Int32</span></td>
  2750. <td><span class="parametername">resultHeight</span></td>
  2751. <td>The real result height.</td>
  2752. </tr>
  2753. </tbody>
  2754. </table>
  2755. <h5 class="returns">Returns</h5>
  2756. <table class="table table-bordered table-striped table-condensed">
  2757. <thead>
  2758. <tr>
  2759. <th>Type</th>
  2760. <th>Description</th>
  2761. </tr>
  2762. </thead>
  2763. <tbody>
  2764. <tr>
  2765. <td><span class="xref">System.Boolean</span></td>
  2766. <td>True if the height can be directly assigned, false otherwise.</td>
  2767. </tr>
  2768. </tbody>
  2769. </table>
  2770. <a id="Terminal_Gui_View_SetNeedsDisplay_" data-uid="Terminal.Gui.View.SetNeedsDisplay*"></a>
  2771. <h4 id="Terminal_Gui_View_SetNeedsDisplay" data-uid="Terminal.Gui.View.SetNeedsDisplay">SetNeedsDisplay()</h4>
  2772. <div class="markdown level1 summary">
  2773. Sets a flag indicating this view needs to be redisplayed because its state has changed.
  2774. </div>
  2775. <div class="markdown level1 conceptual"></div>
  2776. <h5 class="decalaration">Declaration</h5>
  2777. <div class="codewrapper">
  2778. <pre><code class="lang-csharp hljs">public void SetNeedsDisplay()</code></pre>
  2779. </div>
  2780. <a id="Terminal_Gui_View_SetNeedsDisplay_" data-uid="Terminal.Gui.View.SetNeedsDisplay*"></a>
  2781. <h4 id="Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_" data-uid="Terminal.Gui.View.SetNeedsDisplay(Terminal.Gui.Rect)">SetNeedsDisplay(Rect)</h4>
  2782. <div class="markdown level1 summary">
  2783. Flags the view-relative region on this View as needing to be repainted.
  2784. </div>
  2785. <div class="markdown level1 conceptual"></div>
  2786. <h5 class="decalaration">Declaration</h5>
  2787. <div class="codewrapper">
  2788. <pre><code class="lang-csharp hljs">public void SetNeedsDisplay(Rect region)</code></pre>
  2789. </div>
  2790. <h5 class="parameters">Parameters</h5>
  2791. <table class="table table-bordered table-striped table-condensed">
  2792. <thead>
  2793. <tr>
  2794. <th>Type</th>
  2795. <th>Name</th>
  2796. <th>Description</th>
  2797. </tr>
  2798. </thead>
  2799. <tbody>
  2800. <tr>
  2801. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  2802. <td><span class="parametername">region</span></td>
  2803. <td>The view-relative region that must be flagged for repaint.</td>
  2804. </tr>
  2805. </tbody>
  2806. </table>
  2807. <a id="Terminal_Gui_View_SetWidth_" data-uid="Terminal.Gui.View.SetWidth*"></a>
  2808. <h4 id="Terminal_Gui_View_SetWidth_System_Int32_System_Int32__" data-uid="Terminal.Gui.View.SetWidth(System.Int32,System.Int32@)">SetWidth(Int32, out Int32)</h4>
  2809. <div class="markdown level1 summary">
  2810. Calculate the width based on the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">Width</a> settings.
  2811. </div>
  2812. <div class="markdown level1 conceptual"></div>
  2813. <h5 class="decalaration">Declaration</h5>
  2814. <div class="codewrapper">
  2815. <pre><code class="lang-csharp hljs">public bool SetWidth(int desiredWidth, out int resultWidth)</code></pre>
  2816. </div>
  2817. <h5 class="parameters">Parameters</h5>
  2818. <table class="table table-bordered table-striped table-condensed">
  2819. <thead>
  2820. <tr>
  2821. <th>Type</th>
  2822. <th>Name</th>
  2823. <th>Description</th>
  2824. </tr>
  2825. </thead>
  2826. <tbody>
  2827. <tr>
  2828. <td><span class="xref">System.Int32</span></td>
  2829. <td><span class="parametername">desiredWidth</span></td>
  2830. <td>The desired width.</td>
  2831. </tr>
  2832. <tr>
  2833. <td><span class="xref">System.Int32</span></td>
  2834. <td><span class="parametername">resultWidth</span></td>
  2835. <td>The real result width.</td>
  2836. </tr>
  2837. </tbody>
  2838. </table>
  2839. <h5 class="returns">Returns</h5>
  2840. <table class="table table-bordered table-striped table-condensed">
  2841. <thead>
  2842. <tr>
  2843. <th>Type</th>
  2844. <th>Description</th>
  2845. </tr>
  2846. </thead>
  2847. <tbody>
  2848. <tr>
  2849. <td><span class="xref">System.Boolean</span></td>
  2850. <td>True if the width can be directly assigned, false otherwise.</td>
  2851. </tr>
  2852. </tbody>
  2853. </table>
  2854. <a id="Terminal_Gui_View_ToString_" data-uid="Terminal.Gui.View.ToString*"></a>
  2855. <h4 id="Terminal_Gui_View_ToString" data-uid="Terminal.Gui.View.ToString">ToString()</h4>
  2856. <div class="markdown level1 summary">
  2857. Pretty prints the View
  2858. </div>
  2859. <div class="markdown level1 conceptual"></div>
  2860. <h5 class="decalaration">Declaration</h5>
  2861. <div class="codewrapper">
  2862. <pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
  2863. </div>
  2864. <h5 class="returns">Returns</h5>
  2865. <table class="table table-bordered table-striped table-condensed">
  2866. <thead>
  2867. <tr>
  2868. <th>Type</th>
  2869. <th>Description</th>
  2870. </tr>
  2871. </thead>
  2872. <tbody>
  2873. <tr>
  2874. <td><span class="xref">System.String</span></td>
  2875. <td></td>
  2876. </tr>
  2877. </tbody>
  2878. </table>
  2879. <h5 class="overrides">Overrides</h5>
  2880. <div><span class="xref">System.Object.ToString()</span></div>
  2881. <h3 id="events">Events
  2882. </h3>
  2883. <h4 id="Terminal_Gui_View_Added" data-uid="Terminal.Gui.View.Added">Added</h4>
  2884. <div class="markdown level1 summary">
  2885. Event fired when a subview is being added to this view.
  2886. </div>
  2887. <div class="markdown level1 conceptual"></div>
  2888. <h5 class="decalaration">Declaration</h5>
  2889. <div class="codewrapper">
  2890. <pre><code class="lang-csharp hljs">public event Action&lt;View&gt; Added</code></pre>
  2891. </div>
  2892. <h5 class="eventType">Event Type</h5>
  2893. <table class="table table-bordered table-striped table-condensed">
  2894. <thead>
  2895. <tr>
  2896. <th>Type</th>
  2897. <th>Description</th>
  2898. </tr>
  2899. </thead>
  2900. <tbody>
  2901. <tr>
  2902. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.View.html">View</a>&gt;</td>
  2903. <td></td>
  2904. </tr>
  2905. </tbody>
  2906. </table>
  2907. <h4 id="Terminal_Gui_View_DrawContent" data-uid="Terminal.Gui.View.DrawContent">DrawContent</h4>
  2908. <div class="markdown level1 summary">
  2909. Event invoked when the content area of the View is to be drawn.
  2910. </div>
  2911. <div class="markdown level1 conceptual"></div>
  2912. <h5 class="decalaration">Declaration</h5>
  2913. <div class="codewrapper">
  2914. <pre><code class="lang-csharp hljs">public event Action&lt;Rect&gt; DrawContent</code></pre>
  2915. </div>
  2916. <h5 class="eventType">Event Type</h5>
  2917. <table class="table table-bordered table-striped table-condensed">
  2918. <thead>
  2919. <tr>
  2920. <th>Type</th>
  2921. <th>Description</th>
  2922. </tr>
  2923. </thead>
  2924. <tbody>
  2925. <tr>
  2926. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.Rect.html">Rect</a>&gt;</td>
  2927. <td></td>
  2928. </tr>
  2929. </tbody>
  2930. </table>
  2931. <h5 id="Terminal_Gui_View_DrawContent_remarks">Remarks</h5>
  2932. <div class="markdown level1 remarks">
  2933. <p>
  2934. Will be invoked before any subviews added with <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">Add(View)</a> have been drawn.
  2935. </p>
  2936. <p>
  2937. Rect provides the view-relative rectangle describing the currently visible viewport into the <a class="xref" href="Terminal.Gui.View.html">View</a>.
  2938. </p>
  2939. </div>
  2940. <h4 id="Terminal_Gui_View_Enter" data-uid="Terminal.Gui.View.Enter">Enter</h4>
  2941. <div class="markdown level1 summary">
  2942. Event fired when the view gets focus.
  2943. </div>
  2944. <div class="markdown level1 conceptual"></div>
  2945. <h5 class="decalaration">Declaration</h5>
  2946. <div class="codewrapper">
  2947. <pre><code class="lang-csharp hljs">public event Action&lt;View.FocusEventArgs&gt; Enter</code></pre>
  2948. </div>
  2949. <h5 class="eventType">Event Type</h5>
  2950. <table class="table table-bordered table-striped table-condensed">
  2951. <thead>
  2952. <tr>
  2953. <th>Type</th>
  2954. <th>Description</th>
  2955. </tr>
  2956. </thead>
  2957. <tbody>
  2958. <tr>
  2959. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.View.FocusEventArgs.html">View.FocusEventArgs</a>&gt;</td>
  2960. <td></td>
  2961. </tr>
  2962. </tbody>
  2963. </table>
  2964. <h4 id="Terminal_Gui_View_Initialized" data-uid="Terminal.Gui.View.Initialized">Initialized</h4>
  2965. <div class="markdown level1 summary">
  2966. Event called only once when the <a class="xref" href="Terminal.Gui.View.html">View</a> is being initialized for the first time.
  2967. Allows configurations and assignments to be performed before the <a class="xref" href="Terminal.Gui.View.html">View</a> being shown.
  2968. This derived from <span class="xref">System.ComponentModel.ISupportInitializeNotification</span> to allow notify all the views that are being initialized.
  2969. </div>
  2970. <div class="markdown level1 conceptual"></div>
  2971. <h5 class="decalaration">Declaration</h5>
  2972. <div class="codewrapper">
  2973. <pre><code class="lang-csharp hljs">public event EventHandler Initialized</code></pre>
  2974. </div>
  2975. <h5 class="eventType">Event Type</h5>
  2976. <table class="table table-bordered table-striped table-condensed">
  2977. <thead>
  2978. <tr>
  2979. <th>Type</th>
  2980. <th>Description</th>
  2981. </tr>
  2982. </thead>
  2983. <tbody>
  2984. <tr>
  2985. <td><span class="xref">System.EventHandler</span></td>
  2986. <td></td>
  2987. </tr>
  2988. </tbody>
  2989. </table>
  2990. <h4 id="Terminal_Gui_View_KeyDown" data-uid="Terminal.Gui.View.KeyDown">KeyDown</h4>
  2991. <div class="markdown level1 summary">
  2992. Invoked when a key is pressed
  2993. </div>
  2994. <div class="markdown level1 conceptual"></div>
  2995. <h5 class="decalaration">Declaration</h5>
  2996. <div class="codewrapper">
  2997. <pre><code class="lang-csharp hljs">public event Action&lt;View.KeyEventEventArgs&gt; KeyDown</code></pre>
  2998. </div>
  2999. <h5 class="eventType">Event Type</h5>
  3000. <table class="table table-bordered table-striped table-condensed">
  3001. <thead>
  3002. <tr>
  3003. <th>Type</th>
  3004. <th>Description</th>
  3005. </tr>
  3006. </thead>
  3007. <tbody>
  3008. <tr>
  3009. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.View.KeyEventEventArgs.html">View.KeyEventEventArgs</a>&gt;</td>
  3010. <td></td>
  3011. </tr>
  3012. </tbody>
  3013. </table>
  3014. <h4 id="Terminal_Gui_View_KeyPress" data-uid="Terminal.Gui.View.KeyPress">KeyPress</h4>
  3015. <div class="markdown level1 summary">
  3016. Invoked when a character key is pressed and occurs after the key up event.
  3017. </div>
  3018. <div class="markdown level1 conceptual"></div>
  3019. <h5 class="decalaration">Declaration</h5>
  3020. <div class="codewrapper">
  3021. <pre><code class="lang-csharp hljs">public event Action&lt;View.KeyEventEventArgs&gt; KeyPress</code></pre>
  3022. </div>
  3023. <h5 class="eventType">Event Type</h5>
  3024. <table class="table table-bordered table-striped table-condensed">
  3025. <thead>
  3026. <tr>
  3027. <th>Type</th>
  3028. <th>Description</th>
  3029. </tr>
  3030. </thead>
  3031. <tbody>
  3032. <tr>
  3033. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.View.KeyEventEventArgs.html">View.KeyEventEventArgs</a>&gt;</td>
  3034. <td></td>
  3035. </tr>
  3036. </tbody>
  3037. </table>
  3038. <h4 id="Terminal_Gui_View_KeyUp" data-uid="Terminal.Gui.View.KeyUp">KeyUp</h4>
  3039. <div class="markdown level1 summary">
  3040. Invoked when a key is released
  3041. </div>
  3042. <div class="markdown level1 conceptual"></div>
  3043. <h5 class="decalaration">Declaration</h5>
  3044. <div class="codewrapper">
  3045. <pre><code class="lang-csharp hljs">public event Action&lt;View.KeyEventEventArgs&gt; KeyUp</code></pre>
  3046. </div>
  3047. <h5 class="eventType">Event Type</h5>
  3048. <table class="table table-bordered table-striped table-condensed">
  3049. <thead>
  3050. <tr>
  3051. <th>Type</th>
  3052. <th>Description</th>
  3053. </tr>
  3054. </thead>
  3055. <tbody>
  3056. <tr>
  3057. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.View.KeyEventEventArgs.html">View.KeyEventEventArgs</a>&gt;</td>
  3058. <td></td>
  3059. </tr>
  3060. </tbody>
  3061. </table>
  3062. <h4 id="Terminal_Gui_View_LayoutComplete" data-uid="Terminal.Gui.View.LayoutComplete">LayoutComplete</h4>
  3063. <div class="markdown level1 summary">
  3064. Fired after the Views&apos;s <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">LayoutSubviews()</a> method has completed.
  3065. </div>
  3066. <div class="markdown level1 conceptual"></div>
  3067. <h5 class="decalaration">Declaration</h5>
  3068. <div class="codewrapper">
  3069. <pre><code class="lang-csharp hljs">public event Action&lt;View.LayoutEventArgs&gt; LayoutComplete</code></pre>
  3070. </div>
  3071. <h5 class="eventType">Event Type</h5>
  3072. <table class="table table-bordered table-striped table-condensed">
  3073. <thead>
  3074. <tr>
  3075. <th>Type</th>
  3076. <th>Description</th>
  3077. </tr>
  3078. </thead>
  3079. <tbody>
  3080. <tr>
  3081. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.View.LayoutEventArgs.html">View.LayoutEventArgs</a>&gt;</td>
  3082. <td></td>
  3083. </tr>
  3084. </tbody>
  3085. </table>
  3086. <h5 id="Terminal_Gui_View_LayoutComplete_remarks">Remarks</h5>
  3087. <div class="markdown level1 remarks">
  3088. Subscribe to this event to perform tasks when the <a class="xref" href="Terminal.Gui.View.html">View</a> has been resized or the layout has otherwise changed.
  3089. </div>
  3090. <h4 id="Terminal_Gui_View_LayoutStarted" data-uid="Terminal.Gui.View.LayoutStarted">LayoutStarted</h4>
  3091. <div class="markdown level1 summary">
  3092. Fired after the Views&apos;s <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">LayoutSubviews()</a> method has completed.
  3093. </div>
  3094. <div class="markdown level1 conceptual"></div>
  3095. <h5 class="decalaration">Declaration</h5>
  3096. <div class="codewrapper">
  3097. <pre><code class="lang-csharp hljs">public event Action&lt;View.LayoutEventArgs&gt; LayoutStarted</code></pre>
  3098. </div>
  3099. <h5 class="eventType">Event Type</h5>
  3100. <table class="table table-bordered table-striped table-condensed">
  3101. <thead>
  3102. <tr>
  3103. <th>Type</th>
  3104. <th>Description</th>
  3105. </tr>
  3106. </thead>
  3107. <tbody>
  3108. <tr>
  3109. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.View.LayoutEventArgs.html">View.LayoutEventArgs</a>&gt;</td>
  3110. <td></td>
  3111. </tr>
  3112. </tbody>
  3113. </table>
  3114. <h5 id="Terminal_Gui_View_LayoutStarted_remarks">Remarks</h5>
  3115. <div class="markdown level1 remarks">
  3116. Subscribe to this event to perform tasks when the <a class="xref" href="Terminal.Gui.View.html">View</a> has been resized or the layout has otherwise changed.
  3117. </div>
  3118. <h4 id="Terminal_Gui_View_Leave" data-uid="Terminal.Gui.View.Leave">Leave</h4>
  3119. <div class="markdown level1 summary">
  3120. Event fired when the view looses focus.
  3121. </div>
  3122. <div class="markdown level1 conceptual"></div>
  3123. <h5 class="decalaration">Declaration</h5>
  3124. <div class="codewrapper">
  3125. <pre><code class="lang-csharp hljs">public event Action&lt;View.FocusEventArgs&gt; Leave</code></pre>
  3126. </div>
  3127. <h5 class="eventType">Event Type</h5>
  3128. <table class="table table-bordered table-striped table-condensed">
  3129. <thead>
  3130. <tr>
  3131. <th>Type</th>
  3132. <th>Description</th>
  3133. </tr>
  3134. </thead>
  3135. <tbody>
  3136. <tr>
  3137. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.View.FocusEventArgs.html">View.FocusEventArgs</a>&gt;</td>
  3138. <td></td>
  3139. </tr>
  3140. </tbody>
  3141. </table>
  3142. <h4 id="Terminal_Gui_View_MouseClick" data-uid="Terminal.Gui.View.MouseClick">MouseClick</h4>
  3143. <div class="markdown level1 summary">
  3144. Event fired when a mouse event is generated.
  3145. </div>
  3146. <div class="markdown level1 conceptual"></div>
  3147. <h5 class="decalaration">Declaration</h5>
  3148. <div class="codewrapper">
  3149. <pre><code class="lang-csharp hljs">public event Action&lt;View.MouseEventArgs&gt; MouseClick</code></pre>
  3150. </div>
  3151. <h5 class="eventType">Event Type</h5>
  3152. <table class="table table-bordered table-striped table-condensed">
  3153. <thead>
  3154. <tr>
  3155. <th>Type</th>
  3156. <th>Description</th>
  3157. </tr>
  3158. </thead>
  3159. <tbody>
  3160. <tr>
  3161. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.View.MouseEventArgs.html">View.MouseEventArgs</a>&gt;</td>
  3162. <td></td>
  3163. </tr>
  3164. </tbody>
  3165. </table>
  3166. <h4 id="Terminal_Gui_View_MouseEnter" data-uid="Terminal.Gui.View.MouseEnter">MouseEnter</h4>
  3167. <div class="markdown level1 summary">
  3168. Event fired when the view receives the mouse event for the first time.
  3169. </div>
  3170. <div class="markdown level1 conceptual"></div>
  3171. <h5 class="decalaration">Declaration</h5>
  3172. <div class="codewrapper">
  3173. <pre><code class="lang-csharp hljs">public event Action&lt;View.MouseEventArgs&gt; MouseEnter</code></pre>
  3174. </div>
  3175. <h5 class="eventType">Event Type</h5>
  3176. <table class="table table-bordered table-striped table-condensed">
  3177. <thead>
  3178. <tr>
  3179. <th>Type</th>
  3180. <th>Description</th>
  3181. </tr>
  3182. </thead>
  3183. <tbody>
  3184. <tr>
  3185. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.View.MouseEventArgs.html">View.MouseEventArgs</a>&gt;</td>
  3186. <td></td>
  3187. </tr>
  3188. </tbody>
  3189. </table>
  3190. <h4 id="Terminal_Gui_View_MouseLeave" data-uid="Terminal.Gui.View.MouseLeave">MouseLeave</h4>
  3191. <div class="markdown level1 summary">
  3192. Event fired when the view receives a mouse event for the last time.
  3193. </div>
  3194. <div class="markdown level1 conceptual"></div>
  3195. <h5 class="decalaration">Declaration</h5>
  3196. <div class="codewrapper">
  3197. <pre><code class="lang-csharp hljs">public event Action&lt;View.MouseEventArgs&gt; MouseLeave</code></pre>
  3198. </div>
  3199. <h5 class="eventType">Event Type</h5>
  3200. <table class="table table-bordered table-striped table-condensed">
  3201. <thead>
  3202. <tr>
  3203. <th>Type</th>
  3204. <th>Description</th>
  3205. </tr>
  3206. </thead>
  3207. <tbody>
  3208. <tr>
  3209. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.View.MouseEventArgs.html">View.MouseEventArgs</a>&gt;</td>
  3210. <td></td>
  3211. </tr>
  3212. </tbody>
  3213. </table>
  3214. <h4 id="Terminal_Gui_View_Removed" data-uid="Terminal.Gui.View.Removed">Removed</h4>
  3215. <div class="markdown level1 summary">
  3216. Event fired when a subview is being removed from this view.
  3217. </div>
  3218. <div class="markdown level1 conceptual"></div>
  3219. <h5 class="decalaration">Declaration</h5>
  3220. <div class="codewrapper">
  3221. <pre><code class="lang-csharp hljs">public event Action&lt;View&gt; Removed</code></pre>
  3222. </div>
  3223. <h5 class="eventType">Event Type</h5>
  3224. <table class="table table-bordered table-striped table-condensed">
  3225. <thead>
  3226. <tr>
  3227. <th>Type</th>
  3228. <th>Description</th>
  3229. </tr>
  3230. </thead>
  3231. <tbody>
  3232. <tr>
  3233. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.View.html">View</a>&gt;</td>
  3234. <td></td>
  3235. </tr>
  3236. </tbody>
  3237. </table>
  3238. <h3 id="implements">Implements</h3>
  3239. <div>
  3240. <span class="xref">System.IDisposable</span>
  3241. </div>
  3242. <div>
  3243. <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
  3244. </div>
  3245. <div>
  3246. <span class="xref">System.ComponentModel.ISupportInitialize</span>
  3247. </div>
  3248. </article>
  3249. </div>
  3250. <div class="hidden-sm col-md-2" role="complementary">
  3251. <div class="sideaffix">
  3252. <div class="contribution">
  3253. <ul class="nav">
  3254. </ul>
  3255. </div>
  3256. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  3257. <h5>In This Article</h5>
  3258. <div></div>
  3259. </nav>
  3260. </div>
  3261. </div>
  3262. </div>
  3263. </div>
  3264. <footer>
  3265. <div class="grad-bottom"></div>
  3266. <div class="footer">
  3267. <div class="container">
  3268. <span class="pull-right">
  3269. <a href="#top">Back to top</a>
  3270. </span>
  3271. <span>Generated by <strong>DocFX</strong></span>
  3272. </div>
  3273. </div>
  3274. </footer>
  3275. </div>
  3276. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  3277. <script type="text/javascript" src="../../styles/docfx.js"></script>
  3278. <script type="text/javascript" src="../../styles/main.js"></script>
  3279. </body>
  3280. </html>