Terminal.Gui.MessageBox.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276
  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 MessageBox
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class MessageBox
  11. ">
  12. <meta name="generator" content="docfx 2.18.2.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="">
  18. <meta property="docfx:tocrel" content="../toc.html">
  19. </head>
  20. <body data-spy="scroll" data-target="#affix">
  21. <div id="wrapper">
  22. <header>
  23. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  24. <div class="container">
  25. <div class="navbar-header">
  26. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  27. <span class="sr-only">Toggle navigation</span>
  28. <span class="icon-bar"></span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. </button>
  32. <a class="navbar-brand" href="../../index.html">
  33. <img id="logo" class="svg" src="../../logo.svg" alt="">
  34. </a>
  35. </div>
  36. <div class="collapse navbar-collapse" id="navbar">
  37. <form class="navbar-form navbar-right" role="search" id="search">
  38. <div class="form-group">
  39. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  40. </div>
  41. </form>
  42. </div>
  43. </div>
  44. </nav>
  45. <div class="subnav navbar navbar-default">
  46. <div class="container hide-when-search" id="breadcrumb">
  47. <ul class="breadcrumb">
  48. <li></li>
  49. </ul>
  50. </div>
  51. </div>
  52. </header>
  53. <div role="main" class="container body-content hide-when-search">
  54. <div class="sidenav hide-when-search">
  55. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  56. <div class="sidetoggle collapse" id="sidetoggle">
  57. <div id="sidetoc"></div>
  58. </div>
  59. </div>
  60. <div class="article row grid-right">
  61. <div class="col-md-10">
  62. <article class="content wrap" id="_content" data-uid="Terminal.Gui.MessageBox">
  63. <h1 id="Terminal_Gui_MessageBox" data-uid="Terminal.Gui.MessageBox">Class MessageBox
  64. </h1>
  65. <div class="markdown level0 summary"><p>Message box displays a modal message to the user, with a title, a message and a series of options that the user can choose from.</p>
  66. </div>
  67. <div class="markdown level0 conceptual"></div>
  68. <div class="inheritance">
  69. <h5>Inheritance</h5>
  70. <div class="level0"><span class="xref">System.Object</span></div>
  71. <div class="level1"><span class="xref">MessageBox</span></div>
  72. </div>
  73. <h6><strong>Namespace</strong>: <a class="xref" href="../Terminal.Gui.html">Terminal.Gui</a></h6>
  74. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  75. <h5 id="Terminal_Gui_MessageBox_syntax">Syntax</h5>
  76. <div class="codewrapper">
  77. <pre><code class="lang-csharp hljs">public class MessageBox</code></pre>
  78. </div>
  79. <h3 id="constructors">Constructors
  80. </h3>
  81. <a id="Terminal_Gui_MessageBox__ctor_" data-uid="Terminal.Gui.MessageBox.#ctor*"></a>
  82. <h4 id="Terminal_Gui_MessageBox__ctor" data-uid="Terminal.Gui.MessageBox.#ctor">MessageBox()</h4>
  83. <div class="markdown level1 summary"></div>
  84. <div class="markdown level1 conceptual"></div>
  85. <h5 class="decalaration">Declaration</h5>
  86. <div class="codewrapper">
  87. <pre><code class="lang-csharp hljs">public MessageBox ();</code></pre>
  88. </div>
  89. <h3 id="methods">Methods
  90. </h3>
  91. <a id="Terminal_Gui_MessageBox_ErrorQuery_" data-uid="Terminal.Gui.MessageBox.ErrorQuery*"></a>
  92. <h4 id="Terminal_Gui_MessageBox_ErrorQuery_System_Int32_System_Int32_System_String_System_String_System_String___" data-uid="Terminal.Gui.MessageBox.ErrorQuery(System.Int32,System.Int32,System.String,System.String,System.String[])">ErrorQuery(Int32, Int32, String, String, String[])</h4>
  93. <div class="markdown level1 summary"><p>Presents an error message box with the specified title and message and a list of buttons to show to the user.</p>
  94. </div>
  95. <div class="markdown level1 conceptual"></div>
  96. <h5 class="decalaration">Declaration</h5>
  97. <div class="codewrapper">
  98. <pre><code class="lang-csharp hljs">public static int ErrorQuery (int width, int height, string title, string message, string[] buttons);</code></pre>
  99. </div>
  100. <h5 class="parameters">Parameters</h5>
  101. <table class="table table-bordered table-striped table-condensed">
  102. <thead>
  103. <tr>
  104. <th>Type</th>
  105. <th>Name</th>
  106. <th>Description</th>
  107. </tr>
  108. </thead>
  109. <tbody>
  110. <tr>
  111. <td><span class="xref">System.Int32</span></td>
  112. <td><span class="parametername">width</span></td>
  113. <td><p>Width for the window.</p>
  114. </td>
  115. </tr>
  116. <tr>
  117. <td><span class="xref">System.Int32</span></td>
  118. <td><span class="parametername">height</span></td>
  119. <td><p>Height for the window.</p>
  120. </td>
  121. </tr>
  122. <tr>
  123. <td><span class="xref">System.String</span></td>
  124. <td><span class="parametername">title</span></td>
  125. <td><p>Title for the query.</p>
  126. </td>
  127. </tr>
  128. <tr>
  129. <td><span class="xref">System.String</span></td>
  130. <td><span class="parametername">message</span></td>
  131. <td><p>Message to display, might contain multiple lines..</p>
  132. </td>
  133. </tr>
  134. <tr>
  135. <td><span class="xref">System.String</span>[]</td>
  136. <td><span class="parametername">buttons</span></td>
  137. <td><p>Array of buttons to add.</p>
  138. </td>
  139. </tr>
  140. </tbody>
  141. </table>
  142. <h5 class="returns">Returns</h5>
  143. <table class="table table-bordered table-striped table-condensed">
  144. <thead>
  145. <tr>
  146. <th>Type</th>
  147. <th>Description</th>
  148. </tr>
  149. </thead>
  150. <tbody>
  151. <tr>
  152. <td><span class="xref">System.Int32</span></td>
  153. <td><p>The index of the selected button, or -1 if the user pressed ESC to close the dialog.</p>
  154. </td>
  155. </tr>
  156. </tbody>
  157. </table>
  158. <a id="Terminal_Gui_MessageBox_Query_" data-uid="Terminal.Gui.MessageBox.Query*"></a>
  159. <h4 id="Terminal_Gui_MessageBox_Query_System_Int32_System_Int32_System_String_System_String_System_String___" data-uid="Terminal.Gui.MessageBox.Query(System.Int32,System.Int32,System.String,System.String,System.String[])">Query(Int32, Int32, String, String, String[])</h4>
  160. <div class="markdown level1 summary"><p>Presents a message with the specified title and message and a list of buttons to show to the user.</p>
  161. </div>
  162. <div class="markdown level1 conceptual"></div>
  163. <h5 class="decalaration">Declaration</h5>
  164. <div class="codewrapper">
  165. <pre><code class="lang-csharp hljs">public static int Query (int width, int height, string title, string message, string[] buttons);</code></pre>
  166. </div>
  167. <h5 class="parameters">Parameters</h5>
  168. <table class="table table-bordered table-striped table-condensed">
  169. <thead>
  170. <tr>
  171. <th>Type</th>
  172. <th>Name</th>
  173. <th>Description</th>
  174. </tr>
  175. </thead>
  176. <tbody>
  177. <tr>
  178. <td><span class="xref">System.Int32</span></td>
  179. <td><span class="parametername">width</span></td>
  180. <td><p>Width for the window.</p>
  181. </td>
  182. </tr>
  183. <tr>
  184. <td><span class="xref">System.Int32</span></td>
  185. <td><span class="parametername">height</span></td>
  186. <td><p>Height for the window.</p>
  187. </td>
  188. </tr>
  189. <tr>
  190. <td><span class="xref">System.String</span></td>
  191. <td><span class="parametername">title</span></td>
  192. <td><p>Title for the query.</p>
  193. </td>
  194. </tr>
  195. <tr>
  196. <td><span class="xref">System.String</span></td>
  197. <td><span class="parametername">message</span></td>
  198. <td><p>Message to display, might contain multiple lines..</p>
  199. </td>
  200. </tr>
  201. <tr>
  202. <td><span class="xref">System.String</span>[]</td>
  203. <td><span class="parametername">buttons</span></td>
  204. <td><p>Array of buttons to add.</p>
  205. </td>
  206. </tr>
  207. </tbody>
  208. </table>
  209. <h5 class="returns">Returns</h5>
  210. <table class="table table-bordered table-striped table-condensed">
  211. <thead>
  212. <tr>
  213. <th>Type</th>
  214. <th>Description</th>
  215. </tr>
  216. </thead>
  217. <tbody>
  218. <tr>
  219. <td><span class="xref">System.Int32</span></td>
  220. <td><p>The index of the selected button, or -1 if the user pressed ESC to close the dialog.</p>
  221. </td>
  222. </tr>
  223. </tbody>
  224. </table>
  225. </article>
  226. </div>
  227. <div class="hidden-sm col-md-2" role="complementary">
  228. <div class="sideaffix">
  229. <div class="contribution">
  230. <ul class="nav">
  231. </ul>
  232. </div>
  233. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  234. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  235. </nav>
  236. </div>
  237. </div>
  238. </div>
  239. </div>
  240. <footer>
  241. <div class="grad-bottom"></div>
  242. <div class="footer">
  243. <div class="container">
  244. <span class="pull-right">
  245. <a href="#top">Back to top</a>
  246. </span>
  247. <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
  248. </div>
  249. </div>
  250. </footer>
  251. </div>
  252. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  253. <script type="text/javascript" src="../../styles/docfx.js"></script>
  254. <script type="text/javascript" src="../../styles/main.js"></script>
  255. </body>
  256. </html>