Home Explore Help
Sign In
csharp
/
gui-cs.Terminal.Gui
mirror of https://github.com/gui-cs/Terminal.Gui.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: c4e1266326
Branches Tags
gui-cs.Terminal...
/
docs
/
api
/
Terminal.Gui
/
Terminal.Gui.Button.html

Terminal.Gui.Button.html 28 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750 
  1. <!DOCTYPE html>
    2. 

  2. <!--[if IE]><![endif]-->
    3. 

  3. <html>
    4. 

  4.   
    5. 

  5.   <head>
    6. 

  6.     <meta charset="utf-8">
    7. 

  7.     <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    8. 

  8.     <title>Class Button
    9. 

  9.    </title>
    10. 

  10.     <meta name="viewport" content="width=device-width">
    11. 

  11.     <meta name="title" content="Class Button
    12. 

  12.    ">
    13. 

  13.     <meta name="generator" content="docfx 2.18.2.0">
    14. 

  14.     
    15. 

  15.     <link rel="shortcut icon" href="../../favicon.ico">
    16. 

  16.     <link rel="stylesheet" href="../../styles/docfx.vendor.css">
    17. 

  17.     <link rel="stylesheet" href="../../styles/docfx.css">
    18. 

  18.     <link rel="stylesheet" href="../../styles/main.css">
    19. 

  19.     <meta property="docfx:navrel" content="">
    20. 

  20.     <meta property="docfx:tocrel" content="../toc.html">
    21. 

  21.     
    22. 

  22.     
    23. 

  23.   </head>
    24. 

  24.   <body data-spy="scroll" data-target="#affix">
    25. 

  25.     <div id="wrapper">
    26. 

  26.       <header>
    27. 

  27.         
    28. 

  28.         <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
    29. 

  29.           <div class="container">
    30. 

  30.             <div class="navbar-header">
    31. 

  31.               <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
    32. 

  32.                 <span class="sr-only">Toggle navigation</span>
    33. 

  33.                 <span class="icon-bar"></span>
    34. 

  34.                 <span class="icon-bar"></span>
    35. 

  35.                 <span class="icon-bar"></span>
    36. 

  36.               </button>
    37. 

  37.               
    38. 

  38.               <a class="navbar-brand" href="../../index.html">
    39. 

  39.                 <img id="logo" class="svg" src="../../logo.svg" alt="">
    40. 

  40.               </a>
    41. 

  41.             </div>
    42. 

  42.             <div class="collapse navbar-collapse" id="navbar">
    43. 

  43.               <form class="navbar-form navbar-right" role="search" id="search">
    44. 

  44.                 <div class="form-group">
    45. 

  45.                   <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
    46. 

  46.                 </div>
    47. 

  47.               </form>
    48. 

  48.             </div>
    49. 

  49.           </div>
    50. 

  50.         </nav>
    51. 

  51.         
    52. 

  52.         <div class="subnav navbar navbar-default">
    53. 

  53.           <div class="container hide-when-search" id="breadcrumb">
    54. 

  54.             <ul class="breadcrumb">
    55. 

  55.               <li></li>
    56. 

  56.             </ul>
    57. 

  57.           </div>
    58. 

  58.         </div>
    59. 

  59.       </header>
    60. 

  60.       <div role="main" class="container body-content hide-when-search">
    61. 

  61.         
    62. 

  62.         <div class="sidenav hide-when-search">
    63. 

  63.           <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
    64. 

  64.           <div class="sidetoggle collapse" id="sidetoggle">
    65. 

  65.             <div id="sidetoc"></div>
    66. 

  66.           </div>
    67. 

  67.         </div>
    68. 

  68.         <div class="article row grid-right">
    69. 

  69.           <div class="col-md-10">
    70. 

  70.             <article class="content wrap" id="_content" data-uid="Terminal.Gui.Button">
    71. 

  71.   
    72. 

  72.   
    73. 

  73.   <h1 id="Terminal_Gui_Button" data-uid="Terminal.Gui.Button">Class Button
    74. 

  74.   </h1>
    75. 

  75.   <div class="markdown level0 summary"><p>Button is a view that provides an item that invokes a callback when activated.</p>
    76. 

  76. </div>
    77. 

  77.   <div class="markdown level0 conceptual"></div>
    78. 

  78.   <div class="inheritance">
    79. 

  79.     <h5>Inheritance</h5>
    80. 

  80.     <div class="level0"><span class="xref">System.Object</span></div>
    81. 

  81.     <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
    82. 

  82.     <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
    83. 

  83.     <div class="level3"><span class="xref">Button</span></div>
    84. 

  84.   </div>
    85. 

  85.   <div class="inheritedMembers">
    86. 

  86.     <h5>Inherited Members</h5>
    87. 

  87.     <div>
    88. 

  88.       <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_CanFocus">Responder.CanFocus</a>
    89. 

  89.     </div>
    90. 

  90.     <div>
    91. 

  91.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
    92. 

  92.     </div>
    93. 

  93.     <div>
    94. 

  94.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
    95. 

  95.     </div>
    96. 

  96.     <div>
    97. 

  97.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddCh_System_Int32_System_Int32_System_Int32_">View.AddCh(Int32, Int32, Int32)</a>
    98. 

  98.     </div>
    99. 

  99.     <div>
    100. 

  100.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
    101. 

  101.     </div>
    102. 

  102.     <div>
    103. 

  103.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
    104. 

  104.     </div>
    105. 

  105.     <div>
    106. 

  106.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
    107. 

  107.     </div>
    108. 

  108.     <div>
    109. 

  109.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
    110. 

  110.     </div>
    111. 

  111.     <div>
    112. 

  112.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
    113. 

  113.     </div>
    114. 

  114.     <div>
    115. 

  115.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
    116. 

  116.     </div>
    117. 

  117.     <div>
    118. 

  118.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
    119. 

  119.     </div>
    120. 

  120.     <div>
    121. 

  121.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
    122. 

  122.     </div>
    123. 

  123.     <div>
    124. 

  124.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawFrame_Terminal_Gui_Rect_System_Boolean_">View.DrawFrame(Rect, Boolean)</a>
    125. 

  125.     </div>
    126. 

  126.     <div>
    127. 

  127.       <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>
    128. 

  128.     </div>
    129. 

  129.     <div>
    130. 

  130.       <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>
    131. 

  131.     </div>
    132. 

  132.     <div>
    133. 

  133.       <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>
    134. 

  134.     </div>
    135. 

  135.     <div>
    136. 

  136.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawHotString_System_String_System_Boolean_Terminal_Gui_ColorScheme_">View.DrawHotString(String, Boolean, ColorScheme)</a>
    137. 

  137.     </div>
    138. 

  138.     <div>
    139. 

  139.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawHotString_System_String_Terminal_Gui_Attribute_Terminal_Gui_Attribute_">View.DrawHotString(String, Attribute, Attribute)</a>
    140. 

  140.     </div>
    141. 

  141.     <div>
    142. 

  142.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
    143. 

  143.     </div>
    144. 

  144.     <div>
    145. 

  145.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
    146. 

  146.     </div>
    147. 

  147.     <div>
    148. 

  148.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
    149. 

  149.     </div>
    150. 

  150.     <div>
    151. 

  151.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
    152. 

  152.     </div>
    153. 

  153.     <div>
    154. 

  154.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
    155. 

  155.     </div>
    156. 

  156.     <div>
    157. 

  157.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
    158. 

  158.     </div>
    159. 

  159.     <div>
    160. 

  160.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
    161. 

  161.     </div>
    162. 

  162.     <div>
    163. 

  163.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
    164. 

  164.     </div>
    165. 

  165.     <div>
    166. 

  166.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetEnumerator">View.GetEnumerator()</a>
    167. 

  167.     </div>
    168. 

  168.     <div>
    169. 

  169.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
    170. 

  170.     </div>
    171. 

  171.     <div>
    172. 

  172.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
    173. 

  173.     </div>
    174. 

  174.     <div>
    175. 

  175.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
    176. 

  176.     </div>
    177. 

  177.     <div>
    178. 

  178.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
    179. 

  179.     </div>
    180. 

  180.     <div>
    181. 

  181.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
    182. 

  182.     </div>
    183. 

  183.     <div>
    184. 

  184.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
    185. 

  185.     </div>
    186. 

  186.     <div>
    187. 

  187.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
    188. 

  188.     </div>
    189. 

  189.     <div>
    190. 

  190.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
    191. 

  191.     </div>
    192. 

  192.     <div>
    193. 

  193.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
    194. 

  194.     </div>
    195. 

  195.     <div>
    196. 

  196.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus_Terminal_Gui_View_">View.SetFocus(View)</a>
    197. 

  197.     </div>
    198. 

  198.     <div>
    199. 

  199.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
    200. 

  200.     </div>
    201. 

  201.     <div>
    202. 

  202.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
    203. 

  203.     </div>
    204. 

  204.     <div>
    205. 

  205.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
    206. 

  206.     </div>
    207. 

  207.     <div>
    208. 

  208.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
    209. 

  209.     </div>
    210. 

  210.     <div>
    211. 

  211.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
    212. 

  212.     </div>
    213. 

  213.     <div>
    214. 

  214.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
    215. 

  215.     </div>
    216. 

  216.   </div>
    217. 

  217.   <h6><strong>Namespace</strong>: <a class="xref" href="../Terminal.Gui.html">Terminal.Gui</a></h6>
    218. 

  218.   <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
    219. 

  219.   <h5 id="Terminal_Gui_Button_syntax">Syntax</h5>
    220. 

  220.   <div class="codewrapper">
    221. 

  221.     <pre><code class="lang-csharp hljs">public class Button : Terminal.Gui.View</code></pre>
    222. 

  222.   </div>
    223. 

  223.   <h5 id="Terminal_Gui_Button_remarks"><strong>Remarks</strong></h5>
    224. 

  224.   <div class="markdown level0 remarks"><p>
    225. 

  225.               Provides a button that can be clicked, or pressed with
    226. 

  226.               the enter key and processes hotkeys (the first uppercase
    227. 

  227.               letter in the button becomes the hotkey).
    228. 

  228.             </p>
    229. 

  229.     <p>
    230. 

  230.               If the button is configured as the default (IsDefault) the button
    231. 

  231.               will respond to the return key is no other view processes it, and
    232. 

  232.               turns this into a clicked event.
    233. 

  233.             </p></div>
    234. 

  234.   <h3 id="constructors">Constructors
    235. 

  235.   </h3>
    236. 

  236.   
    237. 

  237.   
    238. 

  238.   <a id="Terminal_Gui_Button__ctor_" data-uid="Terminal.Gui.Button.#ctor*"></a>
    239. 

  239.   <h4 id="Terminal_Gui_Button__ctor_System_String_" data-uid="Terminal.Gui.Button.#ctor(System.String)">Button(String)</h4>
    240. 

  240.   <div class="markdown level1 summary"><p>Public constructor, creates a button based on
    241. 

  241.               the given text at position 0,0</p>
    242. 

  242. </div>
    243. 

  243.   <div class="markdown level1 conceptual"></div>
    244. 

  244.   <h5 class="decalaration">Declaration</h5>
    245. 

  245.   <div class="codewrapper">
    246. 

  246.     <pre><code class="lang-csharp hljs">public Button (string s);</code></pre>
    247. 

  247.   </div>
    248. 

  248.   <h5 class="parameters">Parameters</h5>
    249. 

  249.   <table class="table table-bordered table-striped table-condensed">
    250. 

  250.     <thead>
    251. 

  251.       <tr>
    252. 

  252.         <th>Type</th>
    253. 

  253.         <th>Name</th>
    254. 

  254.         <th>Description</th>
    255. 

  255.       </tr>
    256. 

  256.     </thead>
    257. 

  257.     <tbody>
    258. 

  258.       <tr>
    259. 

  259.         <td><span class="xref">System.String</span></td>
    260. 

  260.         <td><span class="parametername">s</span></td>
    261. 

  261.         <td><p>To be added.</p>
    262. 

  262. </td>
    263. 

  263.       </tr>
    264. 

  264.     </tbody>
    265. 

  265.   </table>
    266. 

  266.   <h5 id="Terminal_Gui_Button__ctor_System_String__remarks">Remarks</h5>
    267. 

  267.   <div class="markdown level1 remarks"><p>The size of the button is computed based on the
    268. 

  268.               text length.   This button is not a default button.</p>
    269. 

  269. </div>
    270. 

  270.   
    271. 

  271.   
    272. 

  272.   <a id="Terminal_Gui_Button__ctor_" data-uid="Terminal.Gui.Button.#ctor*"></a>
    273. 

  273.   <h4 id="Terminal_Gui_Button__ctor_System_String_System_Boolean_" data-uid="Terminal.Gui.Button.#ctor(System.String,System.Boolean)">Button(String, Boolean)</h4>
    274. 

  274.   <div class="markdown level1 summary"><p>Public constructor, creates a button based on
    275. 

  275.               the given text.</p>
    276. 

  276. </div>
    277. 

  277.   <div class="markdown level1 conceptual"></div>
    278. 

  278.   <h5 class="decalaration">Declaration</h5>
    279. 

  279.   <div class="codewrapper">
    280. 

  280.     <pre><code class="lang-csharp hljs">public Button (string s, bool is_default);</code></pre>
    281. 

  281.   </div>
    282. 

  282.   <h5 class="parameters">Parameters</h5>
    283. 

  283.   <table class="table table-bordered table-striped table-condensed">
    284. 

  284.     <thead>
    285. 

  285.       <tr>
    286. 

  286.         <th>Type</th>
    287. 

  287.         <th>Name</th>
    288. 

  288.         <th>Description</th>
    289. 

  289.       </tr>
    290. 

  290.     </thead>
    291. 

  291.     <tbody>
    292. 

  292.       <tr>
    293. 

  293.         <td><span class="xref">System.String</span></td>
    294. 

  294.         <td><span class="parametername">s</span></td>
    295. 

  295.         <td><p>To be added.</p>
    296. 

  296. </td>
    297. 

  297.       </tr>
    298. 

  298.       <tr>
    299. 

  299.         <td><span class="xref">System.Boolean</span></td>
    300. 

  300.         <td><span class="parametername">is_default</span></td>
    301. 

  301.         <td><p>To be added.</p>
    302. 

  302. </td>
    303. 

  303.       </tr>
    304. 

  304.     </tbody>
    305. 

  305.   </table>
    306. 

  306.   <h5 id="Terminal_Gui_Button__ctor_System_String_System_Boolean__remarks">Remarks</h5>
    307. 

  307.   <div class="markdown level1 remarks"><p>If the value for is_default is true, a special
    308. 

  308.               decoration is used, and the enter key on a
    309. 

  309.               dialog would implicitly activate this button.</p>
    310. 

  310. </div>
    311. 

  311.   
    312. 

  312.   
    313. 

  313.   <a id="Terminal_Gui_Button__ctor_" data-uid="Terminal.Gui.Button.#ctor*"></a>
    314. 

  314.   <h4 id="Terminal_Gui_Button__ctor_System_Int32_System_Int32_System_String_" data-uid="Terminal.Gui.Button.#ctor(System.Int32,System.Int32,System.String)">Button(Int32, Int32, String)</h4>
    315. 

  315.   <div class="markdown level1 summary"><p>Public constructor, creates a button based on
    316. 

  316.               the given text at the given position.</p>
    317. 

  317. </div>
    318. 

  318.   <div class="markdown level1 conceptual"></div>
    319. 

  319.   <h5 class="decalaration">Declaration</h5>
    320. 

  320.   <div class="codewrapper">
    321. 

  321.     <pre><code class="lang-csharp hljs">public Button (int x, int y, string s);</code></pre>
    322. 

  322.   </div>
    323. 

  323.   <h5 class="parameters">Parameters</h5>
    324. 

  324.   <table class="table table-bordered table-striped table-condensed">
    325. 

  325.     <thead>
    326. 

  326.       <tr>
    327. 

  327.         <th>Type</th>
    328. 

  328.         <th>Name</th>
    329. 

  329.         <th>Description</th>
    330. 

  330.       </tr>
    331. 

  331.     </thead>
    332. 

  332.     <tbody>
    333. 

  333.       <tr>
    334. 

  334.         <td><span class="xref">System.Int32</span></td>
    335. 

  335.         <td><span class="parametername">x</span></td>
    336. 

  336.         <td><p>To be added.</p>
    337. 

  337. </td>
    338. 

  338.       </tr>
    339. 

  339.       <tr>
    340. 

  340.         <td><span class="xref">System.Int32</span></td>
    341. 

  341.         <td><span class="parametername">y</span></td>
    342. 

  342.         <td><p>To be added.</p>
    343. 

  343. </td>
    344. 

  344.       </tr>
    345. 

  345.       <tr>
    346. 

  346.         <td><span class="xref">System.String</span></td>
    347. 

  347.         <td><span class="parametername">s</span></td>
    348. 

  348.         <td><p>To be added.</p>
    349. 

  349. </td>
    350. 

  350.       </tr>
    351. 

  351.     </tbody>
    352. 

  352.   </table>
    353. 

  353.   <h5 id="Terminal_Gui_Button__ctor_System_Int32_System_Int32_System_String__remarks">Remarks</h5>
    354. 

  354.   <div class="markdown level1 remarks"><p>The size of the button is computed based on the
    355. 

  355.               text length.   This button is not a default button.</p>
    356. 

  356. </div>
    357. 

  357.   
    358. 

  358.   
    359. 

  359.   <a id="Terminal_Gui_Button__ctor_" data-uid="Terminal.Gui.Button.#ctor*"></a>
    360. 

  360.   <h4 id="Terminal_Gui_Button__ctor_System_Int32_System_Int32_System_String_System_Boolean_" data-uid="Terminal.Gui.Button.#ctor(System.Int32,System.Int32,System.String,System.Boolean)">Button(Int32, Int32, String, Boolean)</h4>
    361. 

  361.   <div class="markdown level1 summary"><p>Public constructor, creates a button based on
    362. 

  362.               the given text at the given position.</p>
    363. 

  363. </div>
    364. 

  364.   <div class="markdown level1 conceptual"></div>
    365. 

  365.   <h5 class="decalaration">Declaration</h5>
    366. 

  366.   <div class="codewrapper">
    367. 

  367.     <pre><code class="lang-csharp hljs">public Button (int x, int y, string s, bool is_default);</code></pre>
    368. 

  368.   </div>
    369. 

  369.   <h5 class="parameters">Parameters</h5>
    370. 

  370.   <table class="table table-bordered table-striped table-condensed">
    371. 

  371.     <thead>
    372. 

  372.       <tr>
    373. 

  373.         <th>Type</th>
    374. 

  374.         <th>Name</th>
    375. 

  375.         <th>Description</th>
    376. 

  376.       </tr>
    377. 

  377.     </thead>
    378. 

  378.     <tbody>
    379. 

  379.       <tr>
    380. 

  380.         <td><span class="xref">System.Int32</span></td>
    381. 

  381.         <td><span class="parametername">x</span></td>
    382. 

  382.         <td><p>To be added.</p>
    383. 

  383. </td>
    384. 

  384.       </tr>
    385. 

  385.       <tr>
    386. 

  386.         <td><span class="xref">System.Int32</span></td>
    387. 

  387.         <td><span class="parametername">y</span></td>
    388. 

  388.         <td><p>To be added.</p>
    389. 

  389. </td>
    390. 

  390.       </tr>
    391. 

  391.       <tr>
    392. 

  392.         <td><span class="xref">System.String</span></td>
    393. 

  393.         <td><span class="parametername">s</span></td>
    394. 

  394.         <td><p>To be added.</p>
    395. 

  395. </td>
    396. 

  396.       </tr>
    397. 

  397.       <tr>
    398. 

  398.         <td><span class="xref">System.Boolean</span></td>
    399. 

  399.         <td><span class="parametername">is_default</span></td>
    400. 

  400.         <td><p>To be added.</p>
    401. 

  401. </td>
    402. 

  402.       </tr>
    403. 

  403.     </tbody>
    404. 

  404.   </table>
    405. 

  405.   <h5 id="Terminal_Gui_Button__ctor_System_Int32_System_Int32_System_String_System_Boolean__remarks">Remarks</h5>
    406. 

  406.   <div class="markdown level1 remarks"><p>If the value for is_default is true, a special
    407. 

  407.               decoration is used, and the enter key on a
    408. 

  408.               dialog would implicitly activate this button.</p>
    409. 

  409. </div>
    410. 

  410.   <h3 id="fields">Fields
    411. 

  411.   </h3>
    412. 

  412.   
    413. 

  413.   
    414. 

  414.   <h4 id="Terminal_Gui_Button_Clicked" data-uid="Terminal.Gui.Button.Clicked">Clicked</h4>
    415. 

  415.   <div class="markdown level1 summary"><p>Clicked event, raised when the button is clicked.</p>
    416. 

  416. </div>
    417. 

  417.   <div class="markdown level1 conceptual"></div>
    418. 

  418.   <h5 class="decalaration">Declaration</h5>
    419. 

  419.   <div class="codewrapper">
    420. 

  420.     <pre><code class="lang-csharp hljs">public Action Clicked;</code></pre>
    421. 

  421.   </div>
    422. 

  422.   <h5 class="fieldValue">Field Value</h5>
    423. 

  423.   <table class="table table-bordered table-striped table-condensed">
    424. 

  424.     <thead>
    425. 

  425.       <tr>
    426. 

  426.         <th>Type</th>
    427. 

  427.         <th>Description</th>
    428. 

  428.       </tr>
    429. 

  429.     </thead>
    430. 

  430.     <tbody>
    431. 

  431.       <tr>
    432. 

  432.         <td><span class="xref">System.Action</span></td>
    433. 

  433.         <td><p>To be added.</p>
    434. 

  434. </td>
    435. 

  435.       </tr>
    436. 

  436.     </tbody>
    437. 

  437.   </table>
    438. 

  438.   <h5 id="Terminal_Gui_Button_Clicked_remarks">Remarks</h5>
    439. 

  439.   <div class="markdown level1 remarks"><p>Client code can hook up to this event, it is
    440. 

  440.               raised when the button is activated either with
    441. 

  441.               the mouse or the keyboard.</p>
    442. 

  442. </div>
    443. 

  443.   <h3 id="properties">Properties
    444. 

  444.   </h3>
    445. 

  445.   
    446. 

  446.   
    447. 

  447.   <a id="Terminal_Gui_Button_IsDefault_" data-uid="Terminal.Gui.Button.IsDefault*"></a>
    448. 

  448.   <h4 id="Terminal_Gui_Button_IsDefault" data-uid="Terminal.Gui.Button.IsDefault">IsDefault</h4>
    449. 

  449.   <div class="markdown level1 summary"><p>Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.Button.html">Button</a> is the default action to activate on return on a dialog.</p>
    450. 

  450. </div>
    451. 

  451.   <div class="markdown level1 conceptual"></div>
    452. 

  452.   <h5 class="decalaration">Declaration</h5>
    453. 

  453.   <div class="codewrapper">
    454. 

  454.     <pre><code class="lang-csharp hljs">public bool IsDefault { get; set; }</code></pre>
    455. 

  455.   </div>
    456. 

  456.   <h5 class="propertyValue">Property Value</h5>
    457. 

  457.   <table class="table table-bordered table-striped table-condensed">
    458. 

  458.     <thead>
    459. 

  459.       <tr>
    460. 

  460.         <th>Type</th>
    461. 

  461.         <th>Description</th>
    462. 

  462.       </tr>
    463. 

  463.     </thead>
    464. 

  464.     <tbody>
    465. 

  465.       <tr>
    466. 

  466.         <td><span class="xref">System.Boolean</span></td>
    467. 

  467.         <td><p><code>true</code> if is default; otherwise, <code>false</code>.</p>
    468. 

  468. </td>
    469. 

  469.       </tr>
    470. 

  470.     </tbody>
    471. 

  471.   </table>
    472. 

  472.   
    473. 

  473.   
    474. 

  474.   <a id="Terminal_Gui_Button_Text_" data-uid="Terminal.Gui.Button.Text*"></a>
    475. 

  475.   <h4 id="Terminal_Gui_Button_Text" data-uid="Terminal.Gui.Button.Text">Text</h4>
    476. 

  476.   <div class="markdown level1 summary"><p>The text displayed by this widget.</p>
    477. 

  477. </div>
    478. 

  478.   <div class="markdown level1 conceptual"></div>
    479. 

  479.   <h5 class="decalaration">Declaration</h5>
    480. 

  480.   <div class="codewrapper">
    481. 

  481.     <pre><code class="lang-csharp hljs">public NStack.ustring Text { get; set; }</code></pre>
    482. 

  482.   </div>
    483. 

  483.   <h5 class="propertyValue">Property Value</h5>
    484. 

  484.   <table class="table table-bordered table-striped table-condensed">
    485. 

  485.     <thead>
    486. 

  486.       <tr>
    487. 

  487.         <th>Type</th>
    488. 

  488.         <th>Description</th>
    489. 

  489.       </tr>
    490. 

  490.     </thead>
    491. 

  491.     <tbody>
    492. 

  492.       <tr>
    493. 

  493.         <td><span class="xref">NStack.ustring</span></td>
    494. 

  494.         <td><p>To be added.</p>
    495. 

  495. </td>
    496. 

  496.       </tr>
    497. 

  497.     </tbody>
    498. 

  498.   </table>
    499. 

  499.   <h3 id="methods">Methods
    500. 

  500.   </h3>
    501. 

  501.   
    502. 

  502.   
    503. 

  503.   <a id="Terminal_Gui_Button_MouseEvent_" data-uid="Terminal.Gui.Button.MouseEvent*"></a>
    504. 

  504.   <h4 id="Terminal_Gui_Button_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.Button.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
    505. 

  505.   <div class="markdown level1 summary"></div>
    506. 

  506.   <div class="markdown level1 conceptual"></div>
    507. 

  507.   <h5 class="decalaration">Declaration</h5>
    508. 

  508.   <div class="codewrapper">
    509. 

  509.     <pre><code class="lang-csharp hljs">public override bool MouseEvent (Terminal.Gui.MouseEvent me);</code></pre>
    510. 

  510.   </div>
    511. 

  511.   <h5 class="parameters">Parameters</h5>
    512. 

  512.   <table class="table table-bordered table-striped table-condensed">
    513. 

  513.     <thead>
    514. 

  514.       <tr>
    515. 

  515.         <th>Type</th>
    516. 

  516.         <th>Name</th>
    517. 

  517.         <th>Description</th>
    518. 

  518.       </tr>
    519. 

  519.     </thead>
    520. 

  520.     <tbody>
    521. 

  521.       <tr>
    522. 

  522.         <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
    523. 

  523.         <td><span class="parametername">me</span></td>
    524. 

  524.         <td><p>To be added.</p>
    525. 

  525. </td>
    526. 

  526.       </tr>
    527. 

  527.     </tbody>
    528. 

  528.   </table>
    529. 

  529.   <h5 class="returns">Returns</h5>
    530. 

  530.   <table class="table table-bordered table-striped table-condensed">
    531. 

  531.     <thead>
    532. 

  532.       <tr>
    533. 

  533.         <th>Type</th>
    534. 

  534.         <th>Description</th>
    535. 

  535.       </tr>
    536. 

  536.     </thead>
    537. 

  537.     <tbody>
    538. 

  538.       <tr>
    539. 

  539.         <td><span class="xref">System.Boolean</span></td>
    540. 

  540.         <td><p>To be added.</p>
    541. 

  541. </td>
    542. 

  542.       </tr>
    543. 

  543.     </tbody>
    544. 

  544.   </table>
    545. 

  545.   
    546. 

  546.   
    547. 

  547.   <a id="Terminal_Gui_Button_PositionCursor_" data-uid="Terminal.Gui.Button.PositionCursor*"></a>
    548. 

  548.   <h4 id="Terminal_Gui_Button_PositionCursor" data-uid="Terminal.Gui.Button.PositionCursor">PositionCursor()</h4>
    549. 

  549.   <div class="markdown level1 summary"></div>
    550. 

  550.   <div class="markdown level1 conceptual"></div>
    551. 

  551.   <h5 class="decalaration">Declaration</h5>
    552. 

  552.   <div class="codewrapper">
    553. 

  553.     <pre><code class="lang-csharp hljs">public override void PositionCursor ();</code></pre>
    554. 

  554.   </div>
    555. 

  555.   
    556. 

  556.   
    557. 

  557.   <a id="Terminal_Gui_Button_ProcessColdKey_" data-uid="Terminal.Gui.Button.ProcessColdKey*"></a>
    558. 

  558.   <h4 id="Terminal_Gui_Button_ProcessColdKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Button.ProcessColdKey(Terminal.Gui.KeyEvent)">ProcessColdKey(KeyEvent)</h4>
    559. 

  559.   <div class="markdown level1 summary"></div>
    560. 

  560.   <div class="markdown level1 conceptual"></div>
    561. 

  561.   <h5 class="decalaration">Declaration</h5>
    562. 

  562.   <div class="codewrapper">
    563. 

  563.     <pre><code class="lang-csharp hljs">public override bool ProcessColdKey (Terminal.Gui.KeyEvent kb);</code></pre>
    564. 

  564.   </div>
    565. 

  565.   <h5 class="parameters">Parameters</h5>
    566. 

  566.   <table class="table table-bordered table-striped table-condensed">
    567. 

  567.     <thead>
    568. 

  568.       <tr>
    569. 

  569.         <th>Type</th>
    570. 

  570.         <th>Name</th>
    571. 

  571.         <th>Description</th>
    572. 

  572.       </tr>
    573. 

  573.     </thead>
    574. 

  574.     <tbody>
    575. 

  575.       <tr>
    576. 

  576.         <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
    577. 

  577.         <td><span class="parametername">kb</span></td>
    578. 

  578.         <td><p>To be added.</p>
    579. 

  579. </td>
    580. 

  580.       </tr>
    581. 

  581.     </tbody>
    582. 

  582.   </table>
    583. 

  583.   <h5 class="returns">Returns</h5>
    584. 

  584.   <table class="table table-bordered table-striped table-condensed">
    585. 

  585.     <thead>
    586. 

  586.       <tr>
    587. 

  587.         <th>Type</th>
    588. 

  588.         <th>Description</th>
    589. 

  589.       </tr>
    590. 

  590.     </thead>
    591. 

  591.     <tbody>
    592. 

  592.       <tr>
    593. 

  593.         <td><span class="xref">System.Boolean</span></td>
    594. 

  594.         <td><p>To be added.</p>
    595. 

  595. </td>
    596. 

  596.       </tr>
    597. 

  597.     </tbody>
    598. 

  598.   </table>
    599. 

  599.   
    600. 

  600.   
    601. 

  601.   <a id="Terminal_Gui_Button_ProcessHotKey_" data-uid="Terminal.Gui.Button.ProcessHotKey*"></a>
    602. 

  602.   <h4 id="Terminal_Gui_Button_ProcessHotKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Button.ProcessHotKey(Terminal.Gui.KeyEvent)">ProcessHotKey(KeyEvent)</h4>
    603. 

  603.   <div class="markdown level1 summary"></div>
    604. 

  604.   <div class="markdown level1 conceptual"></div>
    605. 

  605.   <h5 class="decalaration">Declaration</h5>
    606. 

  606.   <div class="codewrapper">
    607. 

  607.     <pre><code class="lang-csharp hljs">public override bool ProcessHotKey (Terminal.Gui.KeyEvent kb);</code></pre>
    608. 

  608.   </div>
    609. 

  609.   <h5 class="parameters">Parameters</h5>
    610. 

  610.   <table class="table table-bordered table-striped table-condensed">
    611. 

  611.     <thead>
    612. 

  612.       <tr>
    613. 

  613.         <th>Type</th>
    614. 

  614.         <th>Name</th>
    615. 

  615.         <th>Description</th>
    616. 

  616.       </tr>
    617. 

  617.     </thead>
    618. 

  618.     <tbody>
    619. 

  619.       <tr>
    620. 

  620.         <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
    621. 

  621.         <td><span class="parametername">kb</span></td>
    622. 

  622.         <td><p>To be added.</p>
    623. 

  623. </td>
    624. 

  624.       </tr>
    625. 

  625.     </tbody>
    626. 

  626.   </table>
    627. 

  627.   <h5 class="returns">Returns</h5>
    628. 

  628.   <table class="table table-bordered table-striped table-condensed">
    629. 

  629.     <thead>
    630. 

  630.       <tr>
    631. 

  631.         <th>Type</th>
    632. 

  632.         <th>Description</th>
    633. 

  633.       </tr>
    634. 

  634.     </thead>
    635. 

  635.     <tbody>
    636. 

  636.       <tr>
    637. 

  637.         <td><span class="xref">System.Boolean</span></td>
    638. 

  638.         <td><p>To be added.</p>
    639. 

  639. </td>
    640. 

  640.       </tr>
    641. 

  641.     </tbody>
    642. 

  642.   </table>
    643. 

  643.   
    644. 

  644.   
    645. 

  645.   <a id="Terminal_Gui_Button_ProcessKey_" data-uid="Terminal.Gui.Button.ProcessKey*"></a>
    646. 

  646.   <h4 id="Terminal_Gui_Button_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Button.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
    647. 

  647.   <div class="markdown level1 summary"></div>
    648. 

  648.   <div class="markdown level1 conceptual"></div>
    649. 

  649.   <h5 class="decalaration">Declaration</h5>
    650. 

  650.   <div class="codewrapper">
    651. 

  651.     <pre><code class="lang-csharp hljs">public override bool ProcessKey (Terminal.Gui.KeyEvent kb);</code></pre>
    652. 

  652.   </div>
    653. 

  653.   <h5 class="parameters">Parameters</h5>
    654. 

  654.   <table class="table table-bordered table-striped table-condensed">
    655. 

  655.     <thead>
    656. 

  656.       <tr>
    657. 

  657.         <th>Type</th>
    658. 

  658.         <th>Name</th>
    659. 

  659.         <th>Description</th>
    660. 

  660.       </tr>
    661. 

  661.     </thead>
    662. 

  662.     <tbody>
    663. 

  663.       <tr>
    664. 

  664.         <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
    665. 

  665.         <td><span class="parametername">kb</span></td>
    666. 

  666.         <td><p>To be added.</p>
    667. 

  667. </td>
    668. 

  668.       </tr>
    669. 

  669.     </tbody>
    670. 

  670.   </table>
    671. 

  671.   <h5 class="returns">Returns</h5>
    672. 

  672.   <table class="table table-bordered table-striped table-condensed">
    673. 

  673.     <thead>
    674. 

  674.       <tr>
    675. 

  675.         <th>Type</th>
    676. 

  676.         <th>Description</th>
    677. 

  677.       </tr>
    678. 

  678.     </thead>
    679. 

  679.     <tbody>
    680. 

  680.       <tr>
    681. 

  681.         <td><span class="xref">System.Boolean</span></td>
    682. 

  682.         <td><p>To be added.</p>
    683. 

  683. </td>
    684. 

  684.       </tr>
    685. 

  685.     </tbody>
    686. 

  686.   </table>
    687. 

  687.   
    688. 

  688.   
    689. 

  689.   <a id="Terminal_Gui_Button_Redraw_" data-uid="Terminal.Gui.Button.Redraw*"></a>
    690. 

  690.   <h4 id="Terminal_Gui_Button_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.Button.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
    691. 

  691.   <div class="markdown level1 summary"></div>
    692. 

  692.   <div class="markdown level1 conceptual"></div>
    693. 

  693.   <h5 class="decalaration">Declaration</h5>
    694. 

  694.   <div class="codewrapper">
    695. 

  695.     <pre><code class="lang-csharp hljs">public override void Redraw (Terminal.Gui.Rect region);</code></pre>
    696. 

  696.   </div>
    697. 

  697.   <h5 class="parameters">Parameters</h5>
    698. 

  698.   <table class="table table-bordered table-striped table-condensed">
    699. 

  699.     <thead>
    700. 

  700.       <tr>
    701. 

  701.         <th>Type</th>
    702. 

  702.         <th>Name</th>
    703. 

  703.         <th>Description</th>
    704. 

  704.       </tr>
    705. 

  705.     </thead>
    706. 

  706.     <tbody>
    707. 

  707.       <tr>
    708. 

  708.         <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
    709. 

  709.         <td><span class="parametername">region</span></td>
    710. 

  710.         <td><p>To be added.</p>
    711. 

  711. </td>
    712. 

  712.       </tr>
    713. 

  713.     </tbody>
    714. 

  714.   </table>
    715. 

  715. </article>
    716. 

  716.           </div>
    717. 

  717.           
    718. 

  718.           <div class="hidden-sm col-md-2" role="complementary">
    719. 

  719.             <div class="sideaffix">
    720. 

  720.               <div class="contribution">
    721. 

  721.                 <ul class="nav">
    722. 

  722.                 </ul>
    723. 

  723.               </div>
    724. 

  724.               <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
    725. 

  725.               <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
    726. 

  726.               </nav>
    727. 

  727.             </div>
    728. 

  728.           </div>
    729. 

  729.         </div>
    730. 

  730.       </div>
    731. 

  731.       
    732. 

  732.       <footer>
    733. 

  733.         <div class="grad-bottom"></div>
    734. 

  734.         <div class="footer">
    735. 

  735.           <div class="container">
    736. 

  736.             <span class="pull-right">
    737. 

  737.               <a href="#top">Back to top</a>
    738. 

  738.             </span>
    739. 

  739.             
    740. 

  740.             <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
    741. 

  741.           </div>
    742. 

  742.         </div>
    743. 

  743.       </footer>
    744. 

  744.     </div>
    745. 

  745.     
    746. 

  746.     <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
    747. 

  747.     <script type="text/javascript" src="../../styles/docfx.js"></script>
    748. 

  748.     <script type="text/javascript" src="../../styles/main.js"></script>
    749. 

  749.   </body>
    750. 

  750. </html>
    751.