Terminal.Gui.Label.html 51 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060
  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 Label
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Label
  11. ">
  12. <link rel="shortcut icon" href="../../favicon.ico">
  13. <link rel="stylesheet" href="../../styles/docfx.vendor.min.css">
  14. <link rel="stylesheet" href="../../styles/docfx.css">
  15. <link rel="stylesheet" href="../../styles/main.css">
  16. <meta property="docfx:navrel" content="../../toc.html">
  17. <meta property="docfx:tocrel" content="toc.html">
  18. <meta property="docfx:rel" content="../../">
  19. </head>
  20. <body data-spy="scroll" data-target="#affix" data-offset="120">
  21. <div id="wrapper">
  22. <header>
  23. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  24. <div class="container">
  25. <div class="navbar-header">
  26. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  27. <span class="sr-only">Toggle navigation</span>
  28. <span class="icon-bar"></span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. </button>
  32. <a class="navbar-brand" href="../../index.html">
  33. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  34. </a>
  35. </div>
  36. <div class="collapse navbar-collapse" id="navbar">
  37. <form class="navbar-form navbar-right" role="search" id="search">
  38. <div class="form-group">
  39. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  40. </div>
  41. </form>
  42. </div>
  43. </div>
  44. </nav>
  45. <div class="subnav navbar navbar-default">
  46. <div class="container hide-when-search" id="breadcrumb">
  47. <ul class="breadcrumb">
  48. <li></li>
  49. </ul>
  50. </div>
  51. </div>
  52. </header>
  53. <div class="container body-content">
  54. <div id="search-results">
  55. <div class="search-list">Search Results for <span></span></div>
  56. <div class="sr-items">
  57. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  58. </div>
  59. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  60. </div>
  61. </div>
  62. <div role="main" class="container body-content hide-when-search">
  63. <div class="sidenav hide-when-search">
  64. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  65. <div class="sidetoggle collapse" id="sidetoggle">
  66. <div id="sidetoc"></div>
  67. </div>
  68. </div>
  69. <div class="article row grid-right">
  70. <div class="col-md-10">
  71. <article class="content wrap" id="_content" data-uid="Terminal.Gui.Label">
  72. <h1 id="Terminal_Gui_Label" data-uid="Terminal.Gui.Label" class="text-break">Class Label
  73. </h1>
  74. <div class="markdown level0 summary">The Label <a class="xref" href="Terminal.Gui.View.html">View</a> displays a string at a given position and supports multiple lines separated by newline characters.
  75. Multi-line Labels support word wrap.</div>
  76. <div class="markdown level0 conceptual"></div>
  77. <div class="inheritance">
  78. <h5>Inheritance</h5>
  79. <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
  80. <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
  81. <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
  82. <div class="level3"><span class="xref">Label</span></div>
  83. </div>
  84. <div class="implements">
  85. <h5>Implements</h5>
  86. <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
  87. <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.componentmodel.isupportinitializenotification">ISupportInitializeNotification</a></div>
  88. <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.componentmodel.isupportinitialize">ISupportInitialize</a></div>
  89. </div>
  90. <div class="inheritedMembers">
  91. <h5>Inherited Members</h5>
  92. <div>
  93. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Added">View.Added</a>
  94. </div>
  95. <div>
  96. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Removed">View.Removed</a>
  97. </div>
  98. <div>
  99. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  100. </div>
  101. <div>
  102. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  103. </div>
  104. <div>
  105. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  106. </div>
  107. <div>
  108. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  109. </div>
  110. <div>
  111. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
  112. </div>
  113. <div>
  114. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocusChanged">View.CanFocusChanged</a>
  115. </div>
  116. <div>
  117. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnabledChanged">View.EnabledChanged</a>
  118. </div>
  119. <div>
  120. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VisibleChanged">View.VisibleChanged</a>
  121. </div>
  122. <div>
  123. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeyChanged">View.HotKeyChanged</a>
  124. </div>
  125. <div>
  126. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKey">View.HotKey</a>
  127. </div>
  128. <div>
  129. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">View.HotKeySpecifier</a>
  130. </div>
  131. <div>
  132. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Shortcut">View.Shortcut</a>
  133. </div>
  134. <div>
  135. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutTag">View.ShortcutTag</a>
  136. </div>
  137. <div>
  138. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutAction">View.ShortcutAction</a>
  139. </div>
  140. <div>
  141. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Data">View.Data</a>
  142. </div>
  143. <div>
  144. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  145. </div>
  146. <div>
  147. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  148. </div>
  149. <div>
  150. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndexes">View.TabIndexes</a>
  151. </div>
  152. <div>
  153. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndex">View.TabIndex</a>
  154. </div>
  155. <div>
  156. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabStop">View.TabStop</a>
  157. </div>
  158. <div>
  159. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocus">View.CanFocus</a>
  160. </div>
  161. <div>
  162. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  163. </div>
  164. <div>
  165. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  166. </div>
  167. <div>
  168. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  169. </div>
  170. <div>
  171. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  172. </div>
  173. <div>
  174. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  175. </div>
  176. <div>
  177. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  178. </div>
  179. <div>
  180. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  181. </div>
  182. <div>
  183. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  184. </div>
  185. <div>
  186. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  187. </div>
  188. <div>
  189. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  190. </div>
  191. <div>
  192. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  193. </div>
  194. <div>
  195. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ForceValidatePosDim">View.ForceValidatePosDim</a>
  196. </div>
  197. <div>
  198. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetMinWidthHeight_Terminal_Gui_Size__">View.GetMinWidthHeight(out Size)</a>
  199. </div>
  200. <div>
  201. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetMinWidthHeight">View.SetMinWidthHeight()</a>
  202. </div>
  203. <div>
  204. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextFormatter">View.TextFormatter</a>
  205. </div>
  206. <div>
  207. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  208. </div>
  209. <div>
  210. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_UpdateTextFormatterText">View.UpdateTextFormatterText()</a>
  211. </div>
  212. <div>
  213. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessResizeView">View.ProcessResizeView()</a>
  214. </div>
  215. <div>
  216. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  217. </div>
  218. <div>
  219. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearLayoutNeeded">View.ClearLayoutNeeded()</a>
  220. </div>
  221. <div>
  222. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  223. </div>
  224. <div>
  225. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetChildNeedsDisplay">View.SetChildNeedsDisplay()</a>
  226. </div>
  227. <div>
  228. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  229. </div>
  230. <div>
  231. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(params View[])</a>
  232. </div>
  233. <div>
  234. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  235. </div>
  236. <div>
  237. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  238. </div>
  239. <div>
  240. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  241. </div>
  242. <div>
  243. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  244. </div>
  245. <div>
  246. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  247. </div>
  248. <div>
  249. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  250. </div>
  251. <div>
  252. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  253. </div>
  254. <div>
  255. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  256. </div>
  257. <div>
  258. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(int, int)</a>
  259. </div>
  260. <div>
  261. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  262. </div>
  263. <div>
  264. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  265. </div>
  266. <div>
  267. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawFrame_Terminal_Gui_Rect_System_Int32_System_Boolean_">View.DrawFrame(Rect, int, bool)</a>
  268. </div>
  269. <div>
  270. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawHotString_NStack_ustring_Terminal_Gui_Attribute_Terminal_Gui_Attribute_">View.DrawHotString(ustring, Attribute, Attribute)</a>
  271. </div>
  272. <div>
  273. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawHotString_NStack_ustring_System_Boolean_Terminal_Gui_ColorScheme_">View.DrawHotString(ustring, bool, ColorScheme)</a>
  274. </div>
  275. <div>
  276. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_System_Boolean_">View.Move(int, int, bool)</a>
  277. </div>
  278. <div>
  279. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a>
  280. </div>
  281. <div>
  282. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  283. </div>
  284. <div>
  285. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnAdded_Terminal_Gui_View_">View.OnAdded(View)</a>
  286. </div>
  287. <div>
  288. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnRemoved_Terminal_Gui_View_">View.OnRemoved(View)</a>
  289. </div>
  290. <div>
  291. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave_Terminal_Gui_View_">View.OnLeave(View)</a>
  292. </div>
  293. <div>
  294. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  295. </div>
  296. <div>
  297. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  298. </div>
  299. <div>
  300. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  301. </div>
  302. <div>
  303. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(int, int, Rune)</a>
  304. </div>
  305. <div>
  306. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  307. </div>
  308. <div>
  309. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a>
  310. </div>
  311. <div>
  312. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  313. </div>
  314. <div>
  315. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  316. </div>
  317. <div>
  318. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContentComplete">View.DrawContentComplete</a>
  319. </div>
  320. <div>
  321. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContentComplete_Terminal_Gui_Rect_">View.OnDrawContentComplete(Rect)</a>
  322. </div>
  323. <div>
  324. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus">View.SetFocus()</a>
  325. </div>
  326. <div>
  327. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  328. </div>
  329. <div>
  330. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a>
  331. </div>
  332. <div>
  333. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_InvokeKeybindings_Terminal_Gui_KeyEvent_">View.InvokeKeybindings(KeyEvent)</a>
  334. </div>
  335. <div>
  336. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddKeyBinding_Terminal_Gui_Key_Terminal_Gui_Command___">View.AddKeyBinding(Key, params Command[])</a>
  337. </div>
  338. <div>
  339. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ReplaceKeyBinding_Terminal_Gui_Key_Terminal_Gui_Key_">View.ReplaceKeyBinding(Key, Key)</a>
  340. </div>
  341. <div>
  342. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ContainsKeyBinding_Terminal_Gui_Key_">View.ContainsKeyBinding(Key)</a>
  343. </div>
  344. <div>
  345. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybindings">View.ClearKeybindings()</a>
  346. </div>
  347. <div>
  348. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybinding_Terminal_Gui_Key_">View.ClearKeybinding(Key)</a>
  349. </div>
  350. <div>
  351. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybinding_Terminal_Gui_Command___">View.ClearKeybinding(params Command[])</a>
  352. </div>
  353. <div>
  354. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddCommand_Terminal_Gui_Command_System_Func_System_Nullable_System_Boolean___">View.AddCommand(Command, Func&lt;bool?&gt;)</a>
  355. </div>
  356. <div>
  357. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetSupportedCommands">View.GetSupportedCommands()</a>
  358. </div>
  359. <div>
  360. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetKeyFromCommand_Terminal_Gui_Command___">View.GetKeyFromCommand(params Command[])</a>
  361. </div>
  362. <div>
  363. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  364. </div>
  365. <div>
  366. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  367. </div>
  368. <div>
  369. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  370. </div>
  371. <div>
  372. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  373. </div>
  374. <div>
  375. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  376. </div>
  377. <div>
  378. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  379. </div>
  380. <div>
  381. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  382. </div>
  383. <div>
  384. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  385. </div>
  386. <div>
  387. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  388. </div>
  389. <div>
  390. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  391. </div>
  392. <div>
  393. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStarted">View.LayoutStarted</a>
  394. </div>
  395. <div>
  396. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  397. </div>
  398. <div>
  399. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Initialized">View.Initialized</a>
  400. </div>
  401. <div>
  402. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  403. </div>
  404. <div>
  405. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">View.Text</a>
  406. </div>
  407. <div>
  408. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AutoSize">View.AutoSize</a>
  409. </div>
  410. <div>
  411. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PreserveTrailingSpaces">View.PreserveTrailingSpaces</a>
  412. </div>
  413. <div>
  414. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextAlignment">View.TextAlignment</a>
  415. </div>
  416. <div>
  417. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VerticalTextAlignment">View.VerticalTextAlignment</a>
  418. </div>
  419. <div>
  420. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextDirection">View.TextDirection</a>
  421. </div>
  422. <div>
  423. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsInitialized">View.IsInitialized</a>
  424. </div>
  425. <div>
  426. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsAdded">View.IsAdded</a>
  427. </div>
  428. <div>
  429. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enabled">View.Enabled</a>
  430. </div>
  431. <div>
  432. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearOnVisibleFalse">View.ClearOnVisibleFalse</a>
  433. </div>
  434. <div>
  435. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Visible">View.Visible</a>
  436. </div>
  437. <div>
  438. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Border">View.Border</a>
  439. </div>
  440. <div>
  441. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IgnoreBorderPropertyOnRedraw">View.IgnoreBorderPropertyOnRedraw</a>
  442. </div>
  443. <div>
  444. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  445. </div>
  446. <div>
  447. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetAutoSize">View.GetAutoSize()</a>
  448. </div>
  449. <div>
  450. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetHotKeySpecifierLength_System_Boolean_">View.GetHotKeySpecifierLength(bool)</a>
  451. </div>
  452. <div>
  453. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetTextFormatterBoundsSize">View.GetTextFormatterBoundsSize()</a>
  454. </div>
  455. <div>
  456. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetBoundsTextFormatterSize">View.GetBoundsTextFormatterSize()</a>
  457. </div>
  458. <div>
  459. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  460. </div>
  461. <div>
  462. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  463. </div>
  464. <div>
  465. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseClick_Terminal_Gui_View_MouseEventArgs_">View.OnMouseClick(View.MouseEventArgs)</a>
  466. </div>
  467. <div>
  468. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnCanFocusChanged">View.OnCanFocusChanged()</a>
  469. </div>
  470. <div>
  471. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnabledChanged">View.OnEnabledChanged()</a>
  472. </div>
  473. <div>
  474. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnVisibleChanged">View.OnVisibleChanged()</a>
  475. </div>
  476. <div>
  477. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Dispose_System_Boolean_">View.Dispose(bool)</a>
  478. </div>
  479. <div>
  480. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BeginInit">View.BeginInit()</a>
  481. </div>
  482. <div>
  483. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EndInit">View.EndInit()</a>
  484. </div>
  485. <div>
  486. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetWidth_System_Int32_System_Int32__">View.SetWidth(int, out int)</a>
  487. </div>
  488. <div>
  489. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetHeight_System_Int32_System_Int32__">View.SetHeight(int, out int)</a>
  490. </div>
  491. <div>
  492. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentWidth_System_Int32__">View.GetCurrentWidth(out int)</a>
  493. </div>
  494. <div>
  495. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentHeight_System_Int32__">View.GetCurrentHeight(out int)</a>
  496. </div>
  497. <div>
  498. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetNormalColor">View.GetNormalColor()</a>
  499. </div>
  500. <div>
  501. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetFocusColor">View.GetFocusColor()</a>
  502. </div>
  503. <div>
  504. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetHotNormalColor">View.GetHotNormalColor()</a>
  505. </div>
  506. <div>
  507. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetTopSuperView">View.GetTopSuperView()</a>
  508. </div>
  509. <div>
  510. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a>
  511. </div>
  512. <div>
  513. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose">Responder.Dispose()</a>
  514. </div>
  515. <div>
  516. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
  517. </div>
  518. <div>
  519. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
  520. </div>
  521. <div>
  522. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
  523. </div>
  524. <div>
  525. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
  526. </div>
  527. <div>
  528. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
  529. </div>
  530. <div>
  531. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
  532. </div>
  533. </div>
  534. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.html">Terminal</a>.<a class="xref" href="Terminal.Gui.html">Gui</a></h6>
  535. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  536. <h5 id="Terminal_Gui_Label_syntax">Syntax</h5>
  537. <div class="codewrapper">
  538. <pre><code class="lang-csharp hljs">public class Label : View, IDisposable, ISupportInitializeNotification, ISupportInitialize</code></pre>
  539. </div>
  540. <h5 id="Terminal_Gui_Label_remarks"><strong>Remarks</strong></h5>
  541. <div class="markdown level0 remarks">The <a class="xref" href="Terminal.Gui.Label.html">Label</a> view is functionality identical to <a class="xref" href="Terminal.Gui.View.html">View</a> and is included for API backwards compatibility.</div>
  542. <h3 id="constructors">Constructors
  543. </h3>
  544. <span class="small pull-right mobile-hide">
  545. <span class="divider">|</span>
  546. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Label__ctor.md&amp;value=---%0Auid%3A%20Terminal.Gui.Label.%23ctor%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  547. </span>
  548. <span class="small pull-right mobile-hide">
  549. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Label.cs/#L21">View Source</a>
  550. </span>
  551. <a id="Terminal_Gui_Label__ctor_" data-uid="Terminal.Gui.Label.#ctor*"></a>
  552. <h4 id="Terminal_Gui_Label__ctor" data-uid="Terminal.Gui.Label.#ctor">Label()</h4>
  553. <div class="markdown level1 summary">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.</div>
  554. <div class="markdown level1 conceptual"></div>
  555. <h5 class="declaration">Declaration</h5>
  556. <div class="codewrapper">
  557. <pre><code class="lang-csharp hljs">public Label()</code></pre>
  558. </div>
  559. <h5 id="Terminal_Gui_Label__ctor_remarks">Remarks</h5>
  560. <div class="markdown level1 remarks"><p>
  561. 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.
  562. 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>
  563. coordinates. The initial size (<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a>) will be
  564. adjusted to fit the contents of <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">Text</a>, including newlines ('\n') for multiple lines.
  565. </p>
  566. <p>
  567. If <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">Height</a> is greater than one, word wrapping is provided.
  568. </p>
  569. <p>
  570. This constructor initialize 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>.
  571. 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.
  572. </p></div>
  573. <span class="small pull-right mobile-hide">
  574. <span class="divider">|</span>
  575. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Label__ctor_NStack_ustring_System_Boolean_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Label.%23ctor(NStack.ustring%2CSystem.Boolean)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  576. </span>
  577. <span class="small pull-right mobile-hide">
  578. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Label.cs/#L33">View Source</a>
  579. </span>
  580. <a id="Terminal_Gui_Label__ctor_" data-uid="Terminal.Gui.Label.#ctor*"></a>
  581. <h4 id="Terminal_Gui_Label__ctor_NStack_ustring_System_Boolean_" data-uid="Terminal.Gui.Label.#ctor(NStack.ustring,System.Boolean)">Label(ustring, bool)</h4>
  582. <div class="markdown level1 summary"></div>
  583. <div class="markdown level1 conceptual"></div>
  584. <h5 class="declaration">Declaration</h5>
  585. <div class="codewrapper">
  586. <pre><code class="lang-csharp hljs">public Label(ustring text, bool autosize = true)</code></pre>
  587. </div>
  588. <h5 class="parameters">Parameters</h5>
  589. <table class="table table-bordered table-condensed">
  590. <thead>
  591. <tr>
  592. <th>Type</th>
  593. <th>Name</th>
  594. <th>Description</th>
  595. </tr>
  596. </thead>
  597. <tbody>
  598. <tr>
  599. <td><span class="xref">ustring</span></td>
  600. <td><span class="parametername">text</span></td>
  601. <td></td>
  602. </tr>
  603. <tr>
  604. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  605. <td><span class="parametername">autosize</span></td>
  606. <td></td>
  607. </tr>
  608. </tbody>
  609. </table>
  610. <span class="small pull-right mobile-hide">
  611. <span class="divider">|</span>
  612. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Label__ctor_NStack_ustring_Terminal_Gui_TextDirection_System_Boolean_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Label.%23ctor(NStack.ustring%2CTerminal.Gui.TextDirection%2CSystem.Boolean)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  613. </span>
  614. <span class="small pull-right mobile-hide">
  615. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Label.cs/#L51">View Source</a>
  616. </span>
  617. <a id="Terminal_Gui_Label__ctor_" data-uid="Terminal.Gui.Label.#ctor*"></a>
  618. <h4 id="Terminal_Gui_Label__ctor_NStack_ustring_Terminal_Gui_TextDirection_System_Boolean_" data-uid="Terminal.Gui.Label.#ctor(NStack.ustring,Terminal.Gui.TextDirection,System.Boolean)">Label(ustring, TextDirection, bool)</h4>
  619. <div class="markdown level1 summary"></div>
  620. <div class="markdown level1 conceptual"></div>
  621. <h5 class="declaration">Declaration</h5>
  622. <div class="codewrapper">
  623. <pre><code class="lang-csharp hljs">public Label(ustring text, TextDirection direction, bool autosize = true)</code></pre>
  624. </div>
  625. <h5 class="parameters">Parameters</h5>
  626. <table class="table table-bordered table-condensed">
  627. <thead>
  628. <tr>
  629. <th>Type</th>
  630. <th>Name</th>
  631. <th>Description</th>
  632. </tr>
  633. </thead>
  634. <tbody>
  635. <tr>
  636. <td><span class="xref">ustring</span></td>
  637. <td><span class="parametername">text</span></td>
  638. <td></td>
  639. </tr>
  640. <tr>
  641. <td><a class="xref" href="Terminal.Gui.TextDirection.html">TextDirection</a></td>
  642. <td><span class="parametername">direction</span></td>
  643. <td></td>
  644. </tr>
  645. <tr>
  646. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  647. <td><span class="parametername">autosize</span></td>
  648. <td></td>
  649. </tr>
  650. </tbody>
  651. </table>
  652. <span class="small pull-right mobile-hide">
  653. <span class="divider">|</span>
  654. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Label__ctor_System_Int32_System_Int32_NStack_ustring_System_Boolean_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Label.%23ctor(System.Int32%2CSystem.Int32%2CNStack.ustring%2CSystem.Boolean)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  655. </span>
  656. <span class="small pull-right mobile-hide">
  657. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Label.cs/#L45">View Source</a>
  658. </span>
  659. <a id="Terminal_Gui_Label__ctor_" data-uid="Terminal.Gui.Label.#ctor*"></a>
  660. <h4 id="Terminal_Gui_Label__ctor_System_Int32_System_Int32_NStack_ustring_System_Boolean_" data-uid="Terminal.Gui.Label.#ctor(System.Int32,System.Int32,NStack.ustring,System.Boolean)">Label(int, int, ustring, bool)</h4>
  661. <div class="markdown level1 summary"></div>
  662. <div class="markdown level1 conceptual"></div>
  663. <h5 class="declaration">Declaration</h5>
  664. <div class="codewrapper">
  665. <pre><code class="lang-csharp hljs">public Label(int x, int y, ustring text, bool autosize = true)</code></pre>
  666. </div>
  667. <h5 class="parameters">Parameters</h5>
  668. <table class="table table-bordered table-condensed">
  669. <thead>
  670. <tr>
  671. <th>Type</th>
  672. <th>Name</th>
  673. <th>Description</th>
  674. </tr>
  675. </thead>
  676. <tbody>
  677. <tr>
  678. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
  679. <td><span class="parametername">x</span></td>
  680. <td></td>
  681. </tr>
  682. <tr>
  683. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
  684. <td><span class="parametername">y</span></td>
  685. <td></td>
  686. </tr>
  687. <tr>
  688. <td><span class="xref">ustring</span></td>
  689. <td><span class="parametername">text</span></td>
  690. <td></td>
  691. </tr>
  692. <tr>
  693. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  694. <td><span class="parametername">autosize</span></td>
  695. <td></td>
  696. </tr>
  697. </tbody>
  698. </table>
  699. <span class="small pull-right mobile-hide">
  700. <span class="divider">|</span>
  701. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Label__ctor_Terminal_Gui_Rect_NStack_ustring_System_Boolean_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Label.%23ctor(Terminal.Gui.Rect%2CNStack.ustring%2CSystem.Boolean)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  702. </span>
  703. <span class="small pull-right mobile-hide">
  704. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Label.cs/#L39">View Source</a>
  705. </span>
  706. <a id="Terminal_Gui_Label__ctor_" data-uid="Terminal.Gui.Label.#ctor*"></a>
  707. <h4 id="Terminal_Gui_Label__ctor_Terminal_Gui_Rect_NStack_ustring_System_Boolean_" data-uid="Terminal.Gui.Label.#ctor(Terminal.Gui.Rect,NStack.ustring,System.Boolean)">Label(Rect, ustring, bool)</h4>
  708. <div class="markdown level1 summary"></div>
  709. <div class="markdown level1 conceptual"></div>
  710. <h5 class="declaration">Declaration</h5>
  711. <div class="codewrapper">
  712. <pre><code class="lang-csharp hljs">public Label(Rect rect, ustring text, bool autosize = false)</code></pre>
  713. </div>
  714. <h5 class="parameters">Parameters</h5>
  715. <table class="table table-bordered table-condensed">
  716. <thead>
  717. <tr>
  718. <th>Type</th>
  719. <th>Name</th>
  720. <th>Description</th>
  721. </tr>
  722. </thead>
  723. <tbody>
  724. <tr>
  725. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  726. <td><span class="parametername">rect</span></td>
  727. <td></td>
  728. </tr>
  729. <tr>
  730. <td><span class="xref">ustring</span></td>
  731. <td><span class="parametername">text</span></td>
  732. <td></td>
  733. </tr>
  734. <tr>
  735. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  736. <td><span class="parametername">autosize</span></td>
  737. <td></td>
  738. </tr>
  739. </tbody>
  740. </table>
  741. <span class="small pull-right mobile-hide">
  742. <span class="divider">|</span>
  743. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Label__ctor_Terminal_Gui_Rect_System_Boolean_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Label.%23ctor(Terminal.Gui.Rect%2CSystem.Boolean)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  744. </span>
  745. <span class="small pull-right mobile-hide">
  746. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Label.cs/#L27">View Source</a>
  747. </span>
  748. <a id="Terminal_Gui_Label__ctor_" data-uid="Terminal.Gui.Label.#ctor*"></a>
  749. <h4 id="Terminal_Gui_Label__ctor_Terminal_Gui_Rect_System_Boolean_" data-uid="Terminal.Gui.Label.#ctor(Terminal.Gui.Rect,System.Boolean)">Label(Rect, bool)</h4>
  750. <div class="markdown level1 summary"></div>
  751. <div class="markdown level1 conceptual"></div>
  752. <h5 class="declaration">Declaration</h5>
  753. <div class="codewrapper">
  754. <pre><code class="lang-csharp hljs">public Label(Rect frame, bool autosize = false)</code></pre>
  755. </div>
  756. <h5 class="parameters">Parameters</h5>
  757. <table class="table table-bordered table-condensed">
  758. <thead>
  759. <tr>
  760. <th>Type</th>
  761. <th>Name</th>
  762. <th>Description</th>
  763. </tr>
  764. </thead>
  765. <tbody>
  766. <tr>
  767. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  768. <td><span class="parametername">frame</span></td>
  769. <td></td>
  770. </tr>
  771. <tr>
  772. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  773. <td><span class="parametername">autosize</span></td>
  774. <td></td>
  775. </tr>
  776. </tbody>
  777. </table>
  778. <h3 id="methods">Methods
  779. </h3>
  780. <span class="small pull-right mobile-hide">
  781. <span class="divider">|</span>
  782. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Label_OnClicked.md&amp;value=---%0Auid%3A%20Terminal.Gui.Label.OnClicked%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  783. </span>
  784. <span class="small pull-right mobile-hide">
  785. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Label.cs/#L140">View Source</a>
  786. </span>
  787. <a id="Terminal_Gui_Label_OnClicked_" data-uid="Terminal.Gui.Label.OnClicked*"></a>
  788. <h4 id="Terminal_Gui_Label_OnClicked" data-uid="Terminal.Gui.Label.OnClicked">OnClicked()</h4>
  789. <div class="markdown level1 summary">Virtual method to invoke the <a class="xref" href="Terminal.Gui.Label.html#Terminal_Gui_Label_Clicked">Clicked</a> event.</div>
  790. <div class="markdown level1 conceptual"></div>
  791. <h5 class="declaration">Declaration</h5>
  792. <div class="codewrapper">
  793. <pre><code class="lang-csharp hljs">public virtual void OnClicked()</code></pre>
  794. </div>
  795. <span class="small pull-right mobile-hide">
  796. <span class="divider">|</span>
  797. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Label_OnEnter_Terminal_Gui_View_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Label.OnEnter(Terminal.Gui.View)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  798. </span>
  799. <span class="small pull-right mobile-hide">
  800. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Label.cs/#L117">View Source</a>
  801. </span>
  802. <a id="Terminal_Gui_Label_OnEnter_" data-uid="Terminal.Gui.Label.OnEnter*"></a>
  803. <h4 id="Terminal_Gui_Label_OnEnter_Terminal_Gui_View_" data-uid="Terminal.Gui.Label.OnEnter(Terminal.Gui.View)">OnEnter(View)</h4>
  804. <div class="markdown level1 summary">Method invoked when a view gets focus.</div>
  805. <div class="markdown level1 conceptual"></div>
  806. <h5 class="declaration">Declaration</h5>
  807. <div class="codewrapper">
  808. <pre><code class="lang-csharp hljs">public override bool OnEnter(View view)</code></pre>
  809. </div>
  810. <h5 class="parameters">Parameters</h5>
  811. <table class="table table-bordered table-condensed">
  812. <thead>
  813. <tr>
  814. <th>Type</th>
  815. <th>Name</th>
  816. <th>Description</th>
  817. </tr>
  818. </thead>
  819. <tbody>
  820. <tr>
  821. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  822. <td><span class="parametername">view</span></td>
  823. <td>The view that is losing focus.</td>
  824. </tr>
  825. </tbody>
  826. </table>
  827. <h5 class="returns">Returns</h5>
  828. <table class="table table-bordered table-condensed">
  829. <thead>
  830. <tr>
  831. <th>Type</th>
  832. <th>Description</th>
  833. </tr>
  834. </thead>
  835. <tbody>
  836. <tr>
  837. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  838. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  839. </tr>
  840. </tbody>
  841. </table>
  842. <h5 class="overrides">Overrides</h5>
  843. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter_Terminal_Gui_View_">View.OnEnter(View)</a></div>
  844. <span class="small pull-right mobile-hide">
  845. <span class="divider">|</span>
  846. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Label_OnMouseEvent_Terminal_Gui_MouseEvent_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Label.OnMouseEvent(Terminal.Gui.MouseEvent)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  847. </span>
  848. <span class="small pull-right mobile-hide">
  849. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Label.cs/#L93">View Source</a>
  850. </span>
  851. <a id="Terminal_Gui_Label_OnMouseEvent_" data-uid="Terminal.Gui.Label.OnMouseEvent*"></a>
  852. <h4 id="Terminal_Gui_Label_OnMouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.Label.OnMouseEvent(Terminal.Gui.MouseEvent)">OnMouseEvent(MouseEvent)</h4>
  853. <div class="markdown level1 summary">Method invoked when a mouse event is generated</div>
  854. <div class="markdown level1 conceptual"></div>
  855. <h5 class="declaration">Declaration</h5>
  856. <div class="codewrapper">
  857. <pre><code class="lang-csharp hljs">public override bool OnMouseEvent(MouseEvent mouseEvent)</code></pre>
  858. </div>
  859. <h5 class="parameters">Parameters</h5>
  860. <table class="table table-bordered table-condensed">
  861. <thead>
  862. <tr>
  863. <th>Type</th>
  864. <th>Name</th>
  865. <th>Description</th>
  866. </tr>
  867. </thead>
  868. <tbody>
  869. <tr>
  870. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  871. <td><span class="parametername">mouseEvent</span></td>
  872. <td></td>
  873. </tr>
  874. </tbody>
  875. </table>
  876. <h5 class="returns">Returns</h5>
  877. <table class="table table-bordered table-condensed">
  878. <thead>
  879. <tr>
  880. <th>Type</th>
  881. <th>Description</th>
  882. </tr>
  883. </thead>
  884. <tbody>
  885. <tr>
  886. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  887. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  888. </tr>
  889. </tbody>
  890. </table>
  891. <h5 class="overrides">Overrides</h5>
  892. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a></div>
  893. <span class="small pull-right mobile-hide">
  894. <span class="divider">|</span>
  895. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Label_ProcessHotKey_Terminal_Gui_KeyEvent_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Label.ProcessHotKey(Terminal.Gui.KeyEvent)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  896. </span>
  897. <span class="small pull-right mobile-hide">
  898. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Label.cs/#L125">View Source</a>
  899. </span>
  900. <a id="Terminal_Gui_Label_ProcessHotKey_" data-uid="Terminal.Gui.Label.ProcessHotKey*"></a>
  901. <h4 id="Terminal_Gui_Label_ProcessHotKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Label.ProcessHotKey(Terminal.Gui.KeyEvent)">ProcessHotKey(KeyEvent)</h4>
  902. <div class="markdown level1 summary">This method can be overwritten by view that
  903. want to provide accelerator functionality
  904. (Alt-key for example).</div>
  905. <div class="markdown level1 conceptual"></div>
  906. <h5 class="declaration">Declaration</h5>
  907. <div class="codewrapper">
  908. <pre><code class="lang-csharp hljs">public override bool ProcessHotKey(KeyEvent ke)</code></pre>
  909. </div>
  910. <h5 class="parameters">Parameters</h5>
  911. <table class="table table-bordered table-condensed">
  912. <thead>
  913. <tr>
  914. <th>Type</th>
  915. <th>Name</th>
  916. <th>Description</th>
  917. </tr>
  918. </thead>
  919. <tbody>
  920. <tr>
  921. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  922. <td><span class="parametername">ke</span></td>
  923. <td></td>
  924. </tr>
  925. </tbody>
  926. </table>
  927. <h5 class="returns">Returns</h5>
  928. <table class="table table-bordered table-condensed">
  929. <thead>
  930. <tr>
  931. <th>Type</th>
  932. <th>Description</th>
  933. </tr>
  934. </thead>
  935. <tbody>
  936. <tr>
  937. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  938. <td></td>
  939. </tr>
  940. </tbody>
  941. </table>
  942. <h5 class="overrides">Overrides</h5>
  943. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a></div>
  944. <h5 id="Terminal_Gui_Label_ProcessHotKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
  945. <div class="markdown level1 remarks"><p>
  946. Before keys are sent to the subview on the
  947. current view, all the views are
  948. processed and the key is passed to the widgets
  949. to allow some of them to process the keystroke
  950. as a hot-key. </p>
  951. <p>
  952. For example, if you implement a button that
  953. has a hotkey ok "o", you would catch the
  954. combination Alt-o here. If the event is
  955. caught, you must return true to stop the
  956. keystroke from being dispatched to other
  957. views.
  958. </p></div>
  959. <h3 id="events">Events
  960. </h3>
  961. <span class="small pull-right mobile-hide">
  962. <span class="divider">|</span>
  963. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Label_Clicked.md&amp;value=---%0Auid%3A%20Terminal.Gui.Label.Clicked%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  964. </span>
  965. <span class="small pull-right mobile-hide">
  966. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Label.cs/#L71">View Source</a>
  967. </span>
  968. <h4 id="Terminal_Gui_Label_Clicked" data-uid="Terminal.Gui.Label.Clicked">Clicked</h4>
  969. <div class="markdown level1 summary">Clicked <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action">Action</a>, raised when the user clicks the primary mouse button within the Bounds of this <a class="xref" href="Terminal.Gui.View.html">View</a>
  970. or if the user presses the action key while this view is focused. (TODO: IsDefault)</div>
  971. <div class="markdown level1 conceptual"></div>
  972. <h5 class="declaration">Declaration</h5>
  973. <div class="codewrapper">
  974. <pre><code class="lang-csharp hljs">public event Action Clicked</code></pre>
  975. </div>
  976. <h5 class="eventType">Event Type</h5>
  977. <table class="table table-bordered table-condensed">
  978. <thead>
  979. <tr>
  980. <th>Type</th>
  981. <th>Description</th>
  982. </tr>
  983. </thead>
  984. <tbody>
  985. <tr>
  986. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action">Action</a></td>
  987. <td></td>
  988. </tr>
  989. </tbody>
  990. </table>
  991. <h5 id="Terminal_Gui_Label_Clicked_remarks">Remarks</h5>
  992. <div class="markdown level1 remarks">Client code can hook up to this event, it is
  993. raised when the button is activated either with
  994. the mouse or the keyboard.</div>
  995. <h3 id="implements">Implements</h3>
  996. <div>
  997. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a>
  998. </div>
  999. <div>
  1000. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.componentmodel.isupportinitializenotification">ISupportInitializeNotification</a>
  1001. </div>
  1002. <div>
  1003. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.componentmodel.isupportinitialize">ISupportInitialize</a>
  1004. </div>
  1005. </article>
  1006. </div>
  1007. <div class="hidden-sm col-md-2" role="complementary">
  1008. <div class="sideaffix">
  1009. <div class="contribution">
  1010. <ul class="nav">
  1011. <li>
  1012. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Label.md&amp;value=---%0Auid%3A%20Terminal.Gui.Label%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Edit this page</a>
  1013. </li>
  1014. <li>
  1015. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Views/Label.cs/#L19" class="contribution-link">View Source</a>
  1016. </li>
  1017. </ul>
  1018. </div>
  1019. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  1020. <h5>In this article</h5>
  1021. <div></div>
  1022. </nav>
  1023. </div>
  1024. </div>
  1025. </div>
  1026. </div>
  1027. <footer>
  1028. <div class="grad-bottom"></div>
  1029. <div class="footer">
  1030. <div class="container">
  1031. <span class="pull-right">
  1032. <a href="#top">Back to top</a>
  1033. </span>
  1034. <span>Generated by <strong>DocFX</strong></span>
  1035. </div>
  1036. </div>
  1037. </footer>
  1038. </div>
  1039. <script type="text/javascript" src="../../styles/docfx.vendor.min.js"></script>
  1040. <script type="text/javascript" src="../../styles/docfx.js"></script>
  1041. <script type="text/javascript" src="../../styles/main.js"></script>
  1042. </body>
  1043. </html>