Terminal.Gui.Label.html 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723
  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. <meta name="generator" content="docfx 2.54.0.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <meta property="docfx:navrel" content="../../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Terminal.Gui.Label">
  73. <h1 id="Terminal_Gui_Label" data-uid="Terminal.Gui.Label" class="text-break">Class Label
  74. </h1>
  75. <div class="markdown level0 summary">
  76. The Label <a class="xref" href="Terminal.Gui.View.html">View</a> displays a string at a given position and supports multiple lines separted by newline characters.
  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"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
  84. <div class="level3"><span class="xref">Label</span></div>
  85. </div>
  86. <div classs="implements">
  87. <h5>Implements</h5>
  88. <div><span class="xref">System.Collections.IEnumerable</span></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_Enter">View.Enter</a>
  94. </div>
  95. <div>
  96. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  97. </div>
  98. <div>
  99. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  100. </div>
  101. <div>
  102. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  103. </div>
  104. <div>
  105. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
  106. </div>
  107. <div>
  108. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  109. </div>
  110. <div>
  111. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  112. </div>
  113. <div>
  114. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  115. </div>
  116. <div>
  117. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  118. </div>
  119. <div>
  120. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  121. </div>
  122. <div>
  123. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  124. </div>
  125. <div>
  126. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  127. </div>
  128. <div>
  129. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetEnumerator">View.GetEnumerator()</a>
  130. </div>
  131. <div>
  132. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  133. </div>
  134. <div>
  135. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  136. </div>
  137. <div>
  138. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  139. </div>
  140. <div>
  141. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  142. </div>
  143. <div>
  144. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  145. </div>
  146. <div>
  147. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  148. </div>
  149. <div>
  150. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  151. </div>
  152. <div>
  153. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  154. </div>
  155. <div>
  156. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  157. </div>
  158. <div>
  159. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
  160. </div>
  161. <div>
  162. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  163. </div>
  164. <div>
  165. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  166. </div>
  167. <div>
  168. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  169. </div>
  170. <div>
  171. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  172. </div>
  173. <div>
  174. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  175. </div>
  176. <div>
  177. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  178. </div>
  179. <div>
  180. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  181. </div>
  182. <div>
  183. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  184. </div>
  185. <div>
  186. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  187. </div>
  188. <div>
  189. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  190. </div>
  191. <div>
  192. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  193. </div>
  194. <div>
  195. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  196. </div>
  197. <div>
  198. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  199. </div>
  200. <div>
  201. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawFrame_Terminal_Gui_Rect_System_Int32_System_Boolean_">View.DrawFrame(Rect, Int32, Boolean)</a>
  202. </div>
  203. <div>
  204. <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>
  205. </div>
  206. <div>
  207. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawHotString_NStack_ustring_System_Boolean_Terminal_Gui_ColorScheme_">View.DrawHotString(ustring, Boolean, ColorScheme)</a>
  208. </div>
  209. <div>
  210. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  211. </div>
  212. <div>
  213. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a>
  214. </div>
  215. <div>
  216. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  217. </div>
  218. <div>
  219. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter">View.OnEnter()</a>
  220. </div>
  221. <div>
  222. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave">View.OnLeave()</a>
  223. </div>
  224. <div>
  225. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  226. </div>
  227. <div>
  228. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  229. </div>
  230. <div>
  231. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  232. </div>
  233. <div>
  234. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  235. </div>
  236. <div>
  237. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  238. </div>
  239. <div>
  240. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  241. </div>
  242. <div>
  243. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  244. </div>
  245. <div>
  246. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus_Terminal_Gui_View_">View.SetFocus(View)</a>
  247. </div>
  248. <div>
  249. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  250. </div>
  251. <div>
  252. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a>
  253. </div>
  254. <div>
  255. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  256. </div>
  257. <div>
  258. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  259. </div>
  260. <div>
  261. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  262. </div>
  263. <div>
  264. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  265. </div>
  266. <div>
  267. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  268. </div>
  269. <div>
  270. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  271. </div>
  272. <div>
  273. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  274. </div>
  275. <div>
  276. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  277. </div>
  278. <div>
  279. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  280. </div>
  281. <div>
  282. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  283. </div>
  284. <div>
  285. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  286. </div>
  287. <div>
  288. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  289. </div>
  290. <div>
  291. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  292. </div>
  293. <div>
  294. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  295. </div>
  296. <div>
  297. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  298. </div>
  299. <div>
  300. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  301. </div>
  302. <div>
  303. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
  304. </div>
  305. <div>
  306. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_CanFocus">Responder.CanFocus</a>
  307. </div>
  308. <div>
  309. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a>
  310. </div>
  311. <div>
  312. <span class="xref">System.Object.Equals(System.Object)</span>
  313. </div>
  314. <div>
  315. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  316. </div>
  317. <div>
  318. <span class="xref">System.Object.GetHashCode()</span>
  319. </div>
  320. <div>
  321. <span class="xref">System.Object.GetType()</span>
  322. </div>
  323. <div>
  324. <span class="xref">System.Object.MemberwiseClone()</span>
  325. </div>
  326. <div>
  327. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  328. </div>
  329. </div>
  330. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  331. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  332. <h5 id="Terminal_Gui_Label_syntax">Syntax</h5>
  333. <div class="codewrapper">
  334. <pre><code class="lang-csharp hljs">public class Label : View, IEnumerable</code></pre>
  335. </div>
  336. <h3 id="constructors">Constructors
  337. </h3>
  338. <a id="Terminal_Gui_Label__ctor_" data-uid="Terminal.Gui.Label.#ctor*"></a>
  339. <h4 id="Terminal_Gui_Label__ctor_NStack_ustring_" data-uid="Terminal.Gui.Label.#ctor(NStack.ustring)">Label(ustring)</h4>
  340. <div class="markdown level1 summary">
  341. Initializes a new instance of <a class="xref" href="Terminal.Gui.Label.html">Label</a> and configures the default Width and Height based on the text, the result is suitable for Computed layout.
  342. </div>
  343. <div class="markdown level1 conceptual"></div>
  344. <h5 class="decalaration">Declaration</h5>
  345. <div class="codewrapper">
  346. <pre><code class="lang-csharp hljs">public Label(ustring text)</code></pre>
  347. </div>
  348. <h5 class="parameters">Parameters</h5>
  349. <table class="table table-bordered table-striped table-condensed">
  350. <thead>
  351. <tr>
  352. <th>Type</th>
  353. <th>Name</th>
  354. <th>Description</th>
  355. </tr>
  356. </thead>
  357. <tbody>
  358. <tr>
  359. <td><span class="xref">NStack.ustring</span></td>
  360. <td><span class="parametername">text</span></td>
  361. <td>Text.</td>
  362. </tr>
  363. </tbody>
  364. </table>
  365. <a id="Terminal_Gui_Label__ctor_" data-uid="Terminal.Gui.Label.#ctor*"></a>
  366. <h4 id="Terminal_Gui_Label__ctor_System_Int32_System_Int32_NStack_ustring_" data-uid="Terminal.Gui.Label.#ctor(System.Int32,System.Int32,NStack.ustring)">Label(Int32, Int32, ustring)</h4>
  367. <div class="markdown level1 summary">
  368. Initializes a new instance of <a class="xref" href="Terminal.Gui.Label.html">Label</a> at the given
  369. coordinate with the given string, computes the bounding box
  370. based on the size of the string, assumes that the string contains
  371. newlines for multiple lines, no special breaking rules are used.
  372. </div>
  373. <div class="markdown level1 conceptual"></div>
  374. <h5 class="decalaration">Declaration</h5>
  375. <div class="codewrapper">
  376. <pre><code class="lang-csharp hljs">public Label(int x, int y, ustring text)</code></pre>
  377. </div>
  378. <h5 class="parameters">Parameters</h5>
  379. <table class="table table-bordered table-striped table-condensed">
  380. <thead>
  381. <tr>
  382. <th>Type</th>
  383. <th>Name</th>
  384. <th>Description</th>
  385. </tr>
  386. </thead>
  387. <tbody>
  388. <tr>
  389. <td><span class="xref">System.Int32</span></td>
  390. <td><span class="parametername">x</span></td>
  391. <td></td>
  392. </tr>
  393. <tr>
  394. <td><span class="xref">System.Int32</span></td>
  395. <td><span class="parametername">y</span></td>
  396. <td></td>
  397. </tr>
  398. <tr>
  399. <td><span class="xref">NStack.ustring</span></td>
  400. <td><span class="parametername">text</span></td>
  401. <td></td>
  402. </tr>
  403. </tbody>
  404. </table>
  405. <a id="Terminal_Gui_Label__ctor_" data-uid="Terminal.Gui.Label.#ctor*"></a>
  406. <h4 id="Terminal_Gui_Label__ctor_Terminal_Gui_Rect_NStack_ustring_" data-uid="Terminal.Gui.Label.#ctor(Terminal.Gui.Rect,NStack.ustring)">Label(Rect, ustring)</h4>
  407. <div class="markdown level1 summary">
  408. Initializes a new instance of <a class="xref" href="Terminal.Gui.Label.html">Label</a> at the given
  409. coordinate with the given string and uses the specified
  410. frame for the string.
  411. </div>
  412. <div class="markdown level1 conceptual"></div>
  413. <h5 class="decalaration">Declaration</h5>
  414. <div class="codewrapper">
  415. <pre><code class="lang-csharp hljs">public Label(Rect rect, ustring text)</code></pre>
  416. </div>
  417. <h5 class="parameters">Parameters</h5>
  418. <table class="table table-bordered table-striped table-condensed">
  419. <thead>
  420. <tr>
  421. <th>Type</th>
  422. <th>Name</th>
  423. <th>Description</th>
  424. </tr>
  425. </thead>
  426. <tbody>
  427. <tr>
  428. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  429. <td><span class="parametername">rect</span></td>
  430. <td></td>
  431. </tr>
  432. <tr>
  433. <td><span class="xref">NStack.ustring</span></td>
  434. <td><span class="parametername">text</span></td>
  435. <td></td>
  436. </tr>
  437. </tbody>
  438. </table>
  439. <h3 id="properties">Properties
  440. </h3>
  441. <a id="Terminal_Gui_Label_Text_" data-uid="Terminal.Gui.Label.Text*"></a>
  442. <h4 id="Terminal_Gui_Label_Text" data-uid="Terminal.Gui.Label.Text">Text</h4>
  443. <div class="markdown level1 summary">
  444. The text displayed by the <a class="xref" href="Terminal.Gui.Label.html">Label</a>.
  445. </div>
  446. <div class="markdown level1 conceptual"></div>
  447. <h5 class="decalaration">Declaration</h5>
  448. <div class="codewrapper">
  449. <pre><code class="lang-csharp hljs">public virtual ustring Text { get; set; }</code></pre>
  450. </div>
  451. <h5 class="propertyValue">Property Value</h5>
  452. <table class="table table-bordered table-striped table-condensed">
  453. <thead>
  454. <tr>
  455. <th>Type</th>
  456. <th>Description</th>
  457. </tr>
  458. </thead>
  459. <tbody>
  460. <tr>
  461. <td><span class="xref">NStack.ustring</span></td>
  462. <td></td>
  463. </tr>
  464. </tbody>
  465. </table>
  466. <a id="Terminal_Gui_Label_TextAlignment_" data-uid="Terminal.Gui.Label.TextAlignment*"></a>
  467. <h4 id="Terminal_Gui_Label_TextAlignment" data-uid="Terminal.Gui.Label.TextAlignment">TextAlignment</h4>
  468. <div class="markdown level1 summary">
  469. Controls the text-alignemtn property of the label, changing it will redisplay the <a class="xref" href="Terminal.Gui.Label.html">Label</a>.
  470. </div>
  471. <div class="markdown level1 conceptual"></div>
  472. <h5 class="decalaration">Declaration</h5>
  473. <div class="codewrapper">
  474. <pre><code class="lang-csharp hljs">public TextAlignment TextAlignment { get; set; }</code></pre>
  475. </div>
  476. <h5 class="propertyValue">Property Value</h5>
  477. <table class="table table-bordered table-striped table-condensed">
  478. <thead>
  479. <tr>
  480. <th>Type</th>
  481. <th>Description</th>
  482. </tr>
  483. </thead>
  484. <tbody>
  485. <tr>
  486. <td><a class="xref" href="Terminal.Gui.TextAlignment.html">TextAlignment</a></td>
  487. <td>The text alignment.</td>
  488. </tr>
  489. </tbody>
  490. </table>
  491. <a id="Terminal_Gui_Label_TextColor_" data-uid="Terminal.Gui.Label.TextColor*"></a>
  492. <h4 id="Terminal_Gui_Label_TextColor" data-uid="Terminal.Gui.Label.TextColor">TextColor</h4>
  493. <div class="markdown level1 summary">
  494. The color used for the <a class="xref" href="Terminal.Gui.Label.html">Label</a>.
  495. </div>
  496. <div class="markdown level1 conceptual"></div>
  497. <h5 class="decalaration">Declaration</h5>
  498. <div class="codewrapper">
  499. <pre><code class="lang-csharp hljs">public Attribute TextColor { get; set; }</code></pre>
  500. </div>
  501. <h5 class="propertyValue">Property Value</h5>
  502. <table class="table table-bordered table-striped table-condensed">
  503. <thead>
  504. <tr>
  505. <th>Type</th>
  506. <th>Description</th>
  507. </tr>
  508. </thead>
  509. <tbody>
  510. <tr>
  511. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  512. <td></td>
  513. </tr>
  514. </tbody>
  515. </table>
  516. <h3 id="methods">Methods
  517. </h3>
  518. <a id="Terminal_Gui_Label_MaxWidth_" data-uid="Terminal.Gui.Label.MaxWidth*"></a>
  519. <h4 id="Terminal_Gui_Label_MaxWidth_NStack_ustring_System_Int32_" data-uid="Terminal.Gui.Label.MaxWidth(NStack.ustring,System.Int32)">MaxWidth(ustring, Int32)</h4>
  520. <div class="markdown level1 summary">
  521. Computes the the max width of a line or multilines needed to render by the Label control
  522. </div>
  523. <div class="markdown level1 conceptual"></div>
  524. <h5 class="decalaration">Declaration</h5>
  525. <div class="codewrapper">
  526. <pre><code class="lang-csharp hljs">public static int MaxWidth(ustring text, int width)</code></pre>
  527. </div>
  528. <h5 class="parameters">Parameters</h5>
  529. <table class="table table-bordered table-striped table-condensed">
  530. <thead>
  531. <tr>
  532. <th>Type</th>
  533. <th>Name</th>
  534. <th>Description</th>
  535. </tr>
  536. </thead>
  537. <tbody>
  538. <tr>
  539. <td><span class="xref">NStack.ustring</span></td>
  540. <td><span class="parametername">text</span></td>
  541. <td>Text, may contain newlines.</td>
  542. </tr>
  543. <tr>
  544. <td><span class="xref">System.Int32</span></td>
  545. <td><span class="parametername">width</span></td>
  546. <td>The width for the text.</td>
  547. </tr>
  548. </tbody>
  549. </table>
  550. <h5 class="returns">Returns</h5>
  551. <table class="table table-bordered table-striped table-condensed">
  552. <thead>
  553. <tr>
  554. <th>Type</th>
  555. <th>Description</th>
  556. </tr>
  557. </thead>
  558. <tbody>
  559. <tr>
  560. <td><span class="xref">System.Int32</span></td>
  561. <td>Max width of lines.</td>
  562. </tr>
  563. </tbody>
  564. </table>
  565. <a id="Terminal_Gui_Label_MeasureLines_" data-uid="Terminal.Gui.Label.MeasureLines*"></a>
  566. <h4 id="Terminal_Gui_Label_MeasureLines_NStack_ustring_System_Int32_" data-uid="Terminal.Gui.Label.MeasureLines(NStack.ustring,System.Int32)">MeasureLines(ustring, Int32)</h4>
  567. <div class="markdown level1 summary">
  568. Computes the number of lines needed to render the specified text by the <a class="xref" href="Terminal.Gui.Label.html">Label</a> view
  569. </div>
  570. <div class="markdown level1 conceptual"></div>
  571. <h5 class="decalaration">Declaration</h5>
  572. <div class="codewrapper">
  573. <pre><code class="lang-csharp hljs">public static int MeasureLines(ustring text, int width)</code></pre>
  574. </div>
  575. <h5 class="parameters">Parameters</h5>
  576. <table class="table table-bordered table-striped table-condensed">
  577. <thead>
  578. <tr>
  579. <th>Type</th>
  580. <th>Name</th>
  581. <th>Description</th>
  582. </tr>
  583. </thead>
  584. <tbody>
  585. <tr>
  586. <td><span class="xref">NStack.ustring</span></td>
  587. <td><span class="parametername">text</span></td>
  588. <td>Text, may contain newlines.</td>
  589. </tr>
  590. <tr>
  591. <td><span class="xref">System.Int32</span></td>
  592. <td><span class="parametername">width</span></td>
  593. <td>The width for the text.</td>
  594. </tr>
  595. </tbody>
  596. </table>
  597. <h5 class="returns">Returns</h5>
  598. <table class="table table-bordered table-striped table-condensed">
  599. <thead>
  600. <tr>
  601. <th>Type</th>
  602. <th>Description</th>
  603. </tr>
  604. </thead>
  605. <tbody>
  606. <tr>
  607. <td><span class="xref">System.Int32</span></td>
  608. <td>Number of lines.</td>
  609. </tr>
  610. </tbody>
  611. </table>
  612. <a id="Terminal_Gui_Label_Redraw_" data-uid="Terminal.Gui.Label.Redraw*"></a>
  613. <h4 id="Terminal_Gui_Label_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.Label.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  614. <div class="markdown level1 summary">
  615. Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
  616. </div>
  617. <div class="markdown level1 conceptual"></div>
  618. <h5 class="decalaration">Declaration</h5>
  619. <div class="codewrapper">
  620. <pre><code class="lang-csharp hljs">public override void Redraw(Rect bounds)</code></pre>
  621. </div>
  622. <h5 class="parameters">Parameters</h5>
  623. <table class="table table-bordered table-striped table-condensed">
  624. <thead>
  625. <tr>
  626. <th>Type</th>
  627. <th>Name</th>
  628. <th>Description</th>
  629. </tr>
  630. </thead>
  631. <tbody>
  632. <tr>
  633. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  634. <td><span class="parametername">bounds</span></td>
  635. <td>The bounds (view-relative region) to redraw.</td>
  636. </tr>
  637. </tbody>
  638. </table>
  639. <h5 class="overrides">Overrides</h5>
  640. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  641. <h5 id="Terminal_Gui_Label_Redraw_Terminal_Gui_Rect__remarks">Remarks</h5>
  642. <div class="markdown level1 remarks">
  643. <p>
  644. 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).
  645. </p>
  646. <p>
  647. Views should set the color that they want to use on entry, as otherwise this will inherit
  648. the last color that was set globaly on the driver.
  649. </p>
  650. <p>
  651. 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
  652. larger than the <code>region</code> parameter.
  653. </p>
  654. </div>
  655. <h3 id="implements">Implements</h3>
  656. <div>
  657. <span class="xref">System.Collections.IEnumerable</span>
  658. </div>
  659. </article>
  660. </div>
  661. <div class="hidden-sm col-md-2" role="complementary">
  662. <div class="sideaffix">
  663. <div class="contribution">
  664. <ul class="nav">
  665. </ul>
  666. </div>
  667. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  668. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  669. </nav>
  670. </div>
  671. </div>
  672. </div>
  673. </div>
  674. <footer>
  675. <div class="grad-bottom"></div>
  676. <div class="footer">
  677. <div class="container">
  678. <span class="pull-right">
  679. <a href="#top">Back to top</a>
  680. </span>
  681. <span>Generated by <strong>DocFX</strong></span>
  682. </div>
  683. </div>
  684. </footer>
  685. </div>
  686. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  687. <script type="text/javascript" src="../../styles/docfx.js"></script>
  688. <script type="text/javascript" src="../../styles/main.js"></script>
  689. </body>
  690. </html>