Terminal.Gui.ProgressBar.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666
  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 ProgressBar
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class ProgressBar
  11. ">
  12. <meta name="generator" content="docfx 2.56.6.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.ProgressBar">
  73. <h1 id="Terminal_Gui_ProgressBar" data-uid="Terminal.Gui.ProgressBar" class="text-break">Class ProgressBar
  74. </h1>
  75. <div class="markdown level0 summary">
  76. A Progress Bar view that can indicate progress of an activity visually.
  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">ProgressBar</span></div>
  85. </div>
  86. <div classs="implements">
  87. <h5>Implements</h5>
  88. <div><span class="xref">System.IDisposable</span></div>
  89. <div><span class="xref">System.ComponentModel.ISupportInitializeNotification</span></div>
  90. <div><span class="xref">System.ComponentModel.ISupportInitialize</span></div>
  91. </div>
  92. <div class="inheritedMembers">
  93. <h5>Inherited Members</h5>
  94. <div>
  95. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Added">View.Added</a>
  96. </div>
  97. <div>
  98. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Removed">View.Removed</a>
  99. </div>
  100. <div>
  101. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  102. </div>
  103. <div>
  104. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  105. </div>
  106. <div>
  107. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  108. </div>
  109. <div>
  110. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  111. </div>
  112. <div>
  113. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
  114. </div>
  115. <div>
  116. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKey">View.HotKey</a>
  117. </div>
  118. <div>
  119. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">View.HotKeySpecifier</a>
  120. </div>
  121. <div>
  122. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Shortcut">View.Shortcut</a>
  123. </div>
  124. <div>
  125. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutTag">View.ShortcutTag</a>
  126. </div>
  127. <div>
  128. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutAction">View.ShortcutAction</a>
  129. </div>
  130. <div>
  131. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Data">View.Data</a>
  132. </div>
  133. <div>
  134. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  135. </div>
  136. <div>
  137. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  138. </div>
  139. <div>
  140. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndexes">View.TabIndexes</a>
  141. </div>
  142. <div>
  143. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndex">View.TabIndex</a>
  144. </div>
  145. <div>
  146. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabStop">View.TabStop</a>
  147. </div>
  148. <div>
  149. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocus">View.CanFocus</a>
  150. </div>
  151. <div>
  152. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  153. </div>
  154. <div>
  155. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  156. </div>
  157. <div>
  158. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  159. </div>
  160. <div>
  161. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  162. </div>
  163. <div>
  164. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  165. </div>
  166. <div>
  167. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  168. </div>
  169. <div>
  170. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  171. </div>
  172. <div>
  173. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  174. </div>
  175. <div>
  176. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  177. </div>
  178. <div>
  179. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  180. </div>
  181. <div>
  182. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  183. </div>
  184. <div>
  185. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  186. </div>
  187. <div>
  188. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  189. </div>
  190. <div>
  191. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearLayoutNeeded">View.ClearLayoutNeeded()</a>
  192. </div>
  193. <div>
  194. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  195. </div>
  196. <div>
  197. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetChildNeedsDisplay">View.SetChildNeedsDisplay()</a>
  198. </div>
  199. <div>
  200. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  201. </div>
  202. <div>
  203. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  204. </div>
  205. <div>
  206. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  207. </div>
  208. <div>
  209. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  210. </div>
  211. <div>
  212. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  213. </div>
  214. <div>
  215. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  216. </div>
  217. <div>
  218. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  219. </div>
  220. <div>
  221. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  222. </div>
  223. <div>
  224. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  225. </div>
  226. <div>
  227. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  228. </div>
  229. <div>
  230. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  231. </div>
  232. <div>
  233. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  234. </div>
  235. <div>
  236. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  237. </div>
  238. <div>
  239. <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>
  240. </div>
  241. <div>
  242. <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>
  243. </div>
  244. <div>
  245. <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>
  246. </div>
  247. <div>
  248. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  249. </div>
  250. <div>
  251. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a>
  252. </div>
  253. <div>
  254. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  255. </div>
  256. <div>
  257. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnAdded_Terminal_Gui_View_">View.OnAdded(View)</a>
  258. </div>
  259. <div>
  260. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnRemoved_Terminal_Gui_View_">View.OnRemoved(View)</a>
  261. </div>
  262. <div>
  263. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave_Terminal_Gui_View_">View.OnLeave(View)</a>
  264. </div>
  265. <div>
  266. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  267. </div>
  268. <div>
  269. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  270. </div>
  271. <div>
  272. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  273. </div>
  274. <div>
  275. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  276. </div>
  277. <div>
  278. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  279. </div>
  280. <div>
  281. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  282. </div>
  283. <div>
  284. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  285. </div>
  286. <div>
  287. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus">View.SetFocus()</a>
  288. </div>
  289. <div>
  290. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  291. </div>
  292. <div>
  293. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a>
  294. </div>
  295. <div>
  296. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  297. </div>
  298. <div>
  299. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  300. </div>
  301. <div>
  302. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  303. </div>
  304. <div>
  305. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  306. </div>
  307. <div>
  308. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  309. </div>
  310. <div>
  311. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  312. </div>
  313. <div>
  314. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  315. </div>
  316. <div>
  317. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  318. </div>
  319. <div>
  320. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  321. </div>
  322. <div>
  323. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  324. </div>
  325. <div>
  326. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  327. </div>
  328. <div>
  329. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStarted">View.LayoutStarted</a>
  330. </div>
  331. <div>
  332. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  333. </div>
  334. <div>
  335. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Initialized">View.Initialized</a>
  336. </div>
  337. <div>
  338. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  339. </div>
  340. <div>
  341. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">View.Text</a>
  342. </div>
  343. <div>
  344. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AutoSize">View.AutoSize</a>
  345. </div>
  346. <div>
  347. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextAlignment">View.TextAlignment</a>
  348. </div>
  349. <div>
  350. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsInitialized">View.IsInitialized</a>
  351. </div>
  352. <div>
  353. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  354. </div>
  355. <div>
  356. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  357. </div>
  358. <div>
  359. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  360. </div>
  361. <div>
  362. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
  363. </div>
  364. <div>
  365. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseClick_Terminal_Gui_View_MouseEventArgs_">View.OnMouseClick(View.MouseEventArgs)</a>
  366. </div>
  367. <div>
  368. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Dispose_System_Boolean_">View.Dispose(Boolean)</a>
  369. </div>
  370. <div>
  371. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BeginInit">View.BeginInit()</a>
  372. </div>
  373. <div>
  374. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EndInit">View.EndInit()</a>
  375. </div>
  376. <div>
  377. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Visible">View.Visible</a>
  378. </div>
  379. <div>
  380. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetWidth_System_Int32_System_Int32__">View.SetWidth(Int32, Int32)</a>
  381. </div>
  382. <div>
  383. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetHeight_System_Int32_System_Int32__">View.SetHeight(Int32, Int32)</a>
  384. </div>
  385. <div>
  386. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a>
  387. </div>
  388. <div>
  389. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose">Responder.Dispose()</a>
  390. </div>
  391. <div>
  392. <span class="xref">System.Object.Equals(System.Object)</span>
  393. </div>
  394. <div>
  395. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  396. </div>
  397. <div>
  398. <span class="xref">System.Object.GetHashCode()</span>
  399. </div>
  400. <div>
  401. <span class="xref">System.Object.GetType()</span>
  402. </div>
  403. <div>
  404. <span class="xref">System.Object.MemberwiseClone()</span>
  405. </div>
  406. <div>
  407. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  408. </div>
  409. </div>
  410. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  411. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  412. <h5 id="Terminal_Gui_ProgressBar_syntax">Syntax</h5>
  413. <div class="codewrapper">
  414. <pre><code class="lang-csharp hljs">public class ProgressBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize</code></pre>
  415. </div>
  416. <h5 id="Terminal_Gui_ProgressBar_remarks"><strong>Remarks</strong></h5>
  417. <div class="markdown level0 remarks">
  418. <p>
  419. <a class="xref" href="Terminal.Gui.ProgressBar.html">ProgressBar</a> can operate in two modes, percentage mode, or
  420. activity mode. The progress bar starts in percentage mode and
  421. setting the Fraction property will reflect on the UI the progress
  422. made so far. Activity mode is used when the application has no
  423. way of knowing how much time is left, and is started when the <a class="xref" href="Terminal.Gui.ProgressBar.html#Terminal_Gui_ProgressBar_Pulse">Pulse()</a> method is called.
  424. Call <a class="xref" href="Terminal.Gui.ProgressBar.html#Terminal_Gui_ProgressBar_Pulse">Pulse()</a> repeatedly as progress is made.
  425. </p>
  426. </div>
  427. <h3 id="constructors">Constructors
  428. </h3>
  429. <a id="Terminal_Gui_ProgressBar__ctor_" data-uid="Terminal.Gui.ProgressBar.#ctor*"></a>
  430. <h4 id="Terminal_Gui_ProgressBar__ctor" data-uid="Terminal.Gui.ProgressBar.#ctor">ProgressBar()</h4>
  431. <div class="markdown level1 summary">
  432. Initializes a new instance of the <a class="xref" href="Terminal.Gui.ProgressBar.html">ProgressBar</a> class, starts in percentage mode and uses relative layout.
  433. </div>
  434. <div class="markdown level1 conceptual"></div>
  435. <h5 class="decalaration">Declaration</h5>
  436. <div class="codewrapper">
  437. <pre><code class="lang-csharp hljs">public ProgressBar()</code></pre>
  438. </div>
  439. <a id="Terminal_Gui_ProgressBar__ctor_" data-uid="Terminal.Gui.ProgressBar.#ctor*"></a>
  440. <h4 id="Terminal_Gui_ProgressBar__ctor_Terminal_Gui_Rect_" data-uid="Terminal.Gui.ProgressBar.#ctor(Terminal.Gui.Rect)">ProgressBar(Rect)</h4>
  441. <div class="markdown level1 summary">
  442. Initializes a new instance of the <a class="xref" href="Terminal.Gui.ProgressBar.html">ProgressBar</a> class, starts in percentage mode with an absolute position and size.
  443. </div>
  444. <div class="markdown level1 conceptual"></div>
  445. <h5 class="decalaration">Declaration</h5>
  446. <div class="codewrapper">
  447. <pre><code class="lang-csharp hljs">public ProgressBar(Rect rect)</code></pre>
  448. </div>
  449. <h5 class="parameters">Parameters</h5>
  450. <table class="table table-bordered table-striped table-condensed">
  451. <thead>
  452. <tr>
  453. <th>Type</th>
  454. <th>Name</th>
  455. <th>Description</th>
  456. </tr>
  457. </thead>
  458. <tbody>
  459. <tr>
  460. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  461. <td><span class="parametername">rect</span></td>
  462. <td>Rect.</td>
  463. </tr>
  464. </tbody>
  465. </table>
  466. <h3 id="properties">Properties
  467. </h3>
  468. <a id="Terminal_Gui_ProgressBar_Fraction_" data-uid="Terminal.Gui.ProgressBar.Fraction*"></a>
  469. <h4 id="Terminal_Gui_ProgressBar_Fraction" data-uid="Terminal.Gui.ProgressBar.Fraction">Fraction</h4>
  470. <div class="markdown level1 summary">
  471. Gets or sets the <a class="xref" href="Terminal.Gui.ProgressBar.html">ProgressBar</a> fraction to display, must be a value between 0 and 1.
  472. </div>
  473. <div class="markdown level1 conceptual"></div>
  474. <h5 class="decalaration">Declaration</h5>
  475. <div class="codewrapper">
  476. <pre><code class="lang-csharp hljs">public float Fraction { get; set; }</code></pre>
  477. </div>
  478. <h5 class="propertyValue">Property Value</h5>
  479. <table class="table table-bordered table-striped table-condensed">
  480. <thead>
  481. <tr>
  482. <th>Type</th>
  483. <th>Description</th>
  484. </tr>
  485. </thead>
  486. <tbody>
  487. <tr>
  488. <td><span class="xref">System.Single</span></td>
  489. <td>The fraction representing the progress.</td>
  490. </tr>
  491. </tbody>
  492. </table>
  493. <h3 id="methods">Methods
  494. </h3>
  495. <a id="Terminal_Gui_ProgressBar_OnEnter_" data-uid="Terminal.Gui.ProgressBar.OnEnter*"></a>
  496. <h4 id="Terminal_Gui_ProgressBar_OnEnter_Terminal_Gui_View_" data-uid="Terminal.Gui.ProgressBar.OnEnter(Terminal.Gui.View)">OnEnter(View)</h4>
  497. <div class="markdown level1 summary">
  498. Method invoked when a view gets focus.
  499. </div>
  500. <div class="markdown level1 conceptual"></div>
  501. <h5 class="decalaration">Declaration</h5>
  502. <div class="codewrapper">
  503. <pre><code class="lang-csharp hljs">public override bool OnEnter(View view)</code></pre>
  504. </div>
  505. <h5 class="parameters">Parameters</h5>
  506. <table class="table table-bordered table-striped table-condensed">
  507. <thead>
  508. <tr>
  509. <th>Type</th>
  510. <th>Name</th>
  511. <th>Description</th>
  512. </tr>
  513. </thead>
  514. <tbody>
  515. <tr>
  516. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  517. <td><span class="parametername">view</span></td>
  518. <td>The view that is losing focus.</td>
  519. </tr>
  520. </tbody>
  521. </table>
  522. <h5 class="returns">Returns</h5>
  523. <table class="table table-bordered table-striped table-condensed">
  524. <thead>
  525. <tr>
  526. <th>Type</th>
  527. <th>Description</th>
  528. </tr>
  529. </thead>
  530. <tbody>
  531. <tr>
  532. <td><span class="xref">System.Boolean</span></td>
  533. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  534. </tr>
  535. </tbody>
  536. </table>
  537. <h5 class="overrides">Overrides</h5>
  538. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter_Terminal_Gui_View_">View.OnEnter(View)</a></div>
  539. <a id="Terminal_Gui_ProgressBar_Pulse_" data-uid="Terminal.Gui.ProgressBar.Pulse*"></a>
  540. <h4 id="Terminal_Gui_ProgressBar_Pulse" data-uid="Terminal.Gui.ProgressBar.Pulse">Pulse()</h4>
  541. <div class="markdown level1 summary">
  542. Notifies the <a class="xref" href="Terminal.Gui.ProgressBar.html">ProgressBar</a> that some progress has taken place.
  543. </div>
  544. <div class="markdown level1 conceptual"></div>
  545. <h5 class="decalaration">Declaration</h5>
  546. <div class="codewrapper">
  547. <pre><code class="lang-csharp hljs">public void Pulse()</code></pre>
  548. </div>
  549. <h5 id="Terminal_Gui_ProgressBar_Pulse_remarks">Remarks</h5>
  550. <div class="markdown level1 remarks">
  551. If the <a class="xref" href="Terminal.Gui.ProgressBar.html">ProgressBar</a> is is percentage mode, it switches to activity
  552. mode. If is in activity mode, the marker is moved.
  553. </div>
  554. <a id="Terminal_Gui_ProgressBar_Redraw_" data-uid="Terminal.Gui.ProgressBar.Redraw*"></a>
  555. <h4 id="Terminal_Gui_ProgressBar_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.ProgressBar.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  556. <div class="markdown level1 summary">
  557. Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
  558. </div>
  559. <div class="markdown level1 conceptual"></div>
  560. <h5 class="decalaration">Declaration</h5>
  561. <div class="codewrapper">
  562. <pre><code class="lang-csharp hljs">public override void Redraw(Rect region)</code></pre>
  563. </div>
  564. <h5 class="parameters">Parameters</h5>
  565. <table class="table table-bordered table-striped table-condensed">
  566. <thead>
  567. <tr>
  568. <th>Type</th>
  569. <th>Name</th>
  570. <th>Description</th>
  571. </tr>
  572. </thead>
  573. <tbody>
  574. <tr>
  575. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  576. <td><span class="parametername">region</span></td>
  577. <td></td>
  578. </tr>
  579. </tbody>
  580. </table>
  581. <h5 class="overrides">Overrides</h5>
  582. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  583. <h5 id="Terminal_Gui_ProgressBar_Redraw_Terminal_Gui_Rect__remarks">Remarks</h5>
  584. <div class="markdown level1 remarks">
  585. <p>
  586. 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).
  587. </p>
  588. <p>
  589. Views should set the color that they want to use on entry, as otherwise this will inherit
  590. the last color that was set globally on the driver.
  591. </p>
  592. <p>
  593. 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
  594. larger than the <code>region</code> parameter.
  595. </p>
  596. </div>
  597. <h3 id="implements">Implements</h3>
  598. <div>
  599. <span class="xref">System.IDisposable</span>
  600. </div>
  601. <div>
  602. <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
  603. </div>
  604. <div>
  605. <span class="xref">System.ComponentModel.ISupportInitialize</span>
  606. </div>
  607. </article>
  608. </div>
  609. <div class="hidden-sm col-md-2" role="complementary">
  610. <div class="sideaffix">
  611. <div class="contribution">
  612. <ul class="nav">
  613. </ul>
  614. </div>
  615. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  616. <h5>In This Article</h5>
  617. <div></div>
  618. </nav>
  619. </div>
  620. </div>
  621. </div>
  622. </div>
  623. <footer>
  624. <div class="grad-bottom"></div>
  625. <div class="footer">
  626. <div class="container">
  627. <span class="pull-right">
  628. <a href="#top">Back to top</a>
  629. </span>
  630. <span>Generated by <strong>DocFX</strong></span>
  631. </div>
  632. </div>
  633. </footer>
  634. </div>
  635. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  636. <script type="text/javascript" src="../../styles/docfx.js"></script>
  637. <script type="text/javascript" src="../../styles/main.js"></script>
  638. </body>
  639. </html>