Terminal.Gui.TextValidateProviders.ITextValidateProvider.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525
  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>Interface ITextValidateProvider
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Interface ITextValidateProvider
  11. ">
  12. <meta name="generator" content="docfx 2.56.7.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.TextValidateProviders.ITextValidateProvider">
  73. <h1 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider" class="text-break">Interface ITextValidateProvider
  74. </h1>
  75. <div class="markdown level0 summary">
  76. TextValidateField Providers Interface.
  77. All TextValidateField are created with a ITextValidateProvider.
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.TextValidateProviders.html">Terminal.Gui.TextValidateProviders</a></h6>
  81. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  82. <h5 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_syntax">Syntax</h5>
  83. <div class="codewrapper">
  84. <pre><code class="lang-csharp hljs">public interface ITextValidateProvider</code></pre>
  85. </div>
  86. <h3 id="properties">Properties
  87. </h3>
  88. <a id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_DisplayText_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.DisplayText*"></a>
  89. <h4 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_DisplayText" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.DisplayText">DisplayText</h4>
  90. <div class="markdown level1 summary">
  91. Gets the formatted string for display.
  92. </div>
  93. <div class="markdown level1 conceptual"></div>
  94. <h5 class="decalaration">Declaration</h5>
  95. <div class="codewrapper">
  96. <pre><code class="lang-csharp hljs">ustring DisplayText { get; }</code></pre>
  97. </div>
  98. <h5 class="propertyValue">Property Value</h5>
  99. <table class="table table-bordered table-striped table-condensed">
  100. <thead>
  101. <tr>
  102. <th>Type</th>
  103. <th>Description</th>
  104. </tr>
  105. </thead>
  106. <tbody>
  107. <tr>
  108. <td><span class="xref">NStack.ustring</span></td>
  109. <td></td>
  110. </tr>
  111. </tbody>
  112. </table>
  113. <a id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_Fixed_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.Fixed*"></a>
  114. <h4 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_Fixed" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.Fixed">Fixed</h4>
  115. <div class="markdown level1 summary">
  116. Set that this provider uses a fixed width.
  117. e.g. Masked ones are fixed.
  118. </div>
  119. <div class="markdown level1 conceptual"></div>
  120. <h5 class="decalaration">Declaration</h5>
  121. <div class="codewrapper">
  122. <pre><code class="lang-csharp hljs">bool Fixed { get; }</code></pre>
  123. </div>
  124. <h5 class="propertyValue">Property Value</h5>
  125. <table class="table table-bordered table-striped table-condensed">
  126. <thead>
  127. <tr>
  128. <th>Type</th>
  129. <th>Description</th>
  130. </tr>
  131. </thead>
  132. <tbody>
  133. <tr>
  134. <td><span class="xref">System.Boolean</span></td>
  135. <td></td>
  136. </tr>
  137. </tbody>
  138. </table>
  139. <a id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_IsValid_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.IsValid*"></a>
  140. <h4 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_IsValid" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.IsValid">IsValid</h4>
  141. <div class="markdown level1 summary">
  142. True if the input is valid, otherwise false.
  143. </div>
  144. <div class="markdown level1 conceptual"></div>
  145. <h5 class="decalaration">Declaration</h5>
  146. <div class="codewrapper">
  147. <pre><code class="lang-csharp hljs">bool IsValid { get; }</code></pre>
  148. </div>
  149. <h5 class="propertyValue">Property Value</h5>
  150. <table class="table table-bordered table-striped table-condensed">
  151. <thead>
  152. <tr>
  153. <th>Type</th>
  154. <th>Description</th>
  155. </tr>
  156. </thead>
  157. <tbody>
  158. <tr>
  159. <td><span class="xref">System.Boolean</span></td>
  160. <td></td>
  161. </tr>
  162. </tbody>
  163. </table>
  164. <a id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_Text_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.Text*"></a>
  165. <h4 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_Text" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.Text">Text</h4>
  166. <div class="markdown level1 summary">
  167. Set the input text and get the current value.
  168. </div>
  169. <div class="markdown level1 conceptual"></div>
  170. <h5 class="decalaration">Declaration</h5>
  171. <div class="codewrapper">
  172. <pre><code class="lang-csharp hljs">ustring Text { get; set; }</code></pre>
  173. </div>
  174. <h5 class="propertyValue">Property Value</h5>
  175. <table class="table table-bordered table-striped table-condensed">
  176. <thead>
  177. <tr>
  178. <th>Type</th>
  179. <th>Description</th>
  180. </tr>
  181. </thead>
  182. <tbody>
  183. <tr>
  184. <td><span class="xref">NStack.ustring</span></td>
  185. <td></td>
  186. </tr>
  187. </tbody>
  188. </table>
  189. <h3 id="methods">Methods
  190. </h3>
  191. <a id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_Cursor_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.Cursor*"></a>
  192. <h4 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_Cursor_System_Int32_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.Cursor(System.Int32)">Cursor(Int32)</h4>
  193. <div class="markdown level1 summary">
  194. Set Cursor position to <code data-dev-comment-type="paramref" class="paramref">pos</code>.
  195. </div>
  196. <div class="markdown level1 conceptual"></div>
  197. <h5 class="decalaration">Declaration</h5>
  198. <div class="codewrapper">
  199. <pre><code class="lang-csharp hljs">int Cursor(int pos)</code></pre>
  200. </div>
  201. <h5 class="parameters">Parameters</h5>
  202. <table class="table table-bordered table-striped table-condensed">
  203. <thead>
  204. <tr>
  205. <th>Type</th>
  206. <th>Name</th>
  207. <th>Description</th>
  208. </tr>
  209. </thead>
  210. <tbody>
  211. <tr>
  212. <td><span class="xref">System.Int32</span></td>
  213. <td><span class="parametername">pos</span></td>
  214. <td></td>
  215. </tr>
  216. </tbody>
  217. </table>
  218. <h5 class="returns">Returns</h5>
  219. <table class="table table-bordered table-striped table-condensed">
  220. <thead>
  221. <tr>
  222. <th>Type</th>
  223. <th>Description</th>
  224. </tr>
  225. </thead>
  226. <tbody>
  227. <tr>
  228. <td><span class="xref">System.Int32</span></td>
  229. <td>Return first valid position.</td>
  230. </tr>
  231. </tbody>
  232. </table>
  233. <a id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_CursorEnd_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.CursorEnd*"></a>
  234. <h4 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_CursorEnd" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.CursorEnd">CursorEnd()</h4>
  235. <div class="markdown level1 summary">
  236. Find the last valid character position.
  237. </div>
  238. <div class="markdown level1 conceptual"></div>
  239. <h5 class="decalaration">Declaration</h5>
  240. <div class="codewrapper">
  241. <pre><code class="lang-csharp hljs">int CursorEnd()</code></pre>
  242. </div>
  243. <h5 class="returns">Returns</h5>
  244. <table class="table table-bordered table-striped table-condensed">
  245. <thead>
  246. <tr>
  247. <th>Type</th>
  248. <th>Description</th>
  249. </tr>
  250. </thead>
  251. <tbody>
  252. <tr>
  253. <td><span class="xref">System.Int32</span></td>
  254. <td>New cursor position.</td>
  255. </tr>
  256. </tbody>
  257. </table>
  258. <a id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_CursorLeft_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.CursorLeft*"></a>
  259. <h4 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_CursorLeft_System_Int32_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.CursorLeft(System.Int32)">CursorLeft(Int32)</h4>
  260. <div class="markdown level1 summary">
  261. First valid position before <code data-dev-comment-type="paramref" class="paramref">pos</code>.
  262. </div>
  263. <div class="markdown level1 conceptual"></div>
  264. <h5 class="decalaration">Declaration</h5>
  265. <div class="codewrapper">
  266. <pre><code class="lang-csharp hljs">int CursorLeft(int pos)</code></pre>
  267. </div>
  268. <h5 class="parameters">Parameters</h5>
  269. <table class="table table-bordered table-striped table-condensed">
  270. <thead>
  271. <tr>
  272. <th>Type</th>
  273. <th>Name</th>
  274. <th>Description</th>
  275. </tr>
  276. </thead>
  277. <tbody>
  278. <tr>
  279. <td><span class="xref">System.Int32</span></td>
  280. <td><span class="parametername">pos</span></td>
  281. <td></td>
  282. </tr>
  283. </tbody>
  284. </table>
  285. <h5 class="returns">Returns</h5>
  286. <table class="table table-bordered table-striped table-condensed">
  287. <thead>
  288. <tr>
  289. <th>Type</th>
  290. <th>Description</th>
  291. </tr>
  292. </thead>
  293. <tbody>
  294. <tr>
  295. <td><span class="xref">System.Int32</span></td>
  296. <td>New cursor position if any, otherwise returns <code data-dev-comment-type="paramref" class="paramref">pos</code></td>
  297. </tr>
  298. </tbody>
  299. </table>
  300. <a id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_CursorRight_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.CursorRight*"></a>
  301. <h4 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_CursorRight_System_Int32_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.CursorRight(System.Int32)">CursorRight(Int32)</h4>
  302. <div class="markdown level1 summary">
  303. First valid position after <code data-dev-comment-type="paramref" class="paramref">pos</code>.
  304. </div>
  305. <div class="markdown level1 conceptual"></div>
  306. <h5 class="decalaration">Declaration</h5>
  307. <div class="codewrapper">
  308. <pre><code class="lang-csharp hljs">int CursorRight(int pos)</code></pre>
  309. </div>
  310. <h5 class="parameters">Parameters</h5>
  311. <table class="table table-bordered table-striped table-condensed">
  312. <thead>
  313. <tr>
  314. <th>Type</th>
  315. <th>Name</th>
  316. <th>Description</th>
  317. </tr>
  318. </thead>
  319. <tbody>
  320. <tr>
  321. <td><span class="xref">System.Int32</span></td>
  322. <td><span class="parametername">pos</span></td>
  323. <td>Current position.</td>
  324. </tr>
  325. </tbody>
  326. </table>
  327. <h5 class="returns">Returns</h5>
  328. <table class="table table-bordered table-striped table-condensed">
  329. <thead>
  330. <tr>
  331. <th>Type</th>
  332. <th>Description</th>
  333. </tr>
  334. </thead>
  335. <tbody>
  336. <tr>
  337. <td><span class="xref">System.Int32</span></td>
  338. <td>New cursor position if any, otherwise returns <code data-dev-comment-type="paramref" class="paramref">pos</code></td>
  339. </tr>
  340. </tbody>
  341. </table>
  342. <a id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_CursorStart_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.CursorStart*"></a>
  343. <h4 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_CursorStart" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.CursorStart">CursorStart()</h4>
  344. <div class="markdown level1 summary">
  345. Find the first valid character position.
  346. </div>
  347. <div class="markdown level1 conceptual"></div>
  348. <h5 class="decalaration">Declaration</h5>
  349. <div class="codewrapper">
  350. <pre><code class="lang-csharp hljs">int CursorStart()</code></pre>
  351. </div>
  352. <h5 class="returns">Returns</h5>
  353. <table class="table table-bordered table-striped table-condensed">
  354. <thead>
  355. <tr>
  356. <th>Type</th>
  357. <th>Description</th>
  358. </tr>
  359. </thead>
  360. <tbody>
  361. <tr>
  362. <td><span class="xref">System.Int32</span></td>
  363. <td>New cursor position.</td>
  364. </tr>
  365. </tbody>
  366. </table>
  367. <a id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_Delete_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.Delete*"></a>
  368. <h4 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_Delete_System_Int32_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.Delete(System.Int32)">Delete(Int32)</h4>
  369. <div class="markdown level1 summary">
  370. Deletes the current character in <code data-dev-comment-type="paramref" class="paramref">pos</code>.
  371. </div>
  372. <div class="markdown level1 conceptual"></div>
  373. <h5 class="decalaration">Declaration</h5>
  374. <div class="codewrapper">
  375. <pre><code class="lang-csharp hljs">bool Delete(int pos)</code></pre>
  376. </div>
  377. <h5 class="parameters">Parameters</h5>
  378. <table class="table table-bordered table-striped table-condensed">
  379. <thead>
  380. <tr>
  381. <th>Type</th>
  382. <th>Name</th>
  383. <th>Description</th>
  384. </tr>
  385. </thead>
  386. <tbody>
  387. <tr>
  388. <td><span class="xref">System.Int32</span></td>
  389. <td><span class="parametername">pos</span></td>
  390. <td></td>
  391. </tr>
  392. </tbody>
  393. </table>
  394. <h5 class="returns">Returns</h5>
  395. <table class="table table-bordered table-striped table-condensed">
  396. <thead>
  397. <tr>
  398. <th>Type</th>
  399. <th>Description</th>
  400. </tr>
  401. </thead>
  402. <tbody>
  403. <tr>
  404. <td><span class="xref">System.Boolean</span></td>
  405. <td>true if the character was successfully removed, otherwise false.</td>
  406. </tr>
  407. </tbody>
  408. </table>
  409. <a id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_InsertAt_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.InsertAt*"></a>
  410. <h4 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_InsertAt_System_Char_System_Int32_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.InsertAt(System.Char,System.Int32)">InsertAt(Char, Int32)</h4>
  411. <div class="markdown level1 summary">
  412. Insert character <code data-dev-comment-type="paramref" class="paramref">ch</code> in position <code data-dev-comment-type="paramref" class="paramref">pos</code>.
  413. </div>
  414. <div class="markdown level1 conceptual"></div>
  415. <h5 class="decalaration">Declaration</h5>
  416. <div class="codewrapper">
  417. <pre><code class="lang-csharp hljs">bool InsertAt(char ch, int pos)</code></pre>
  418. </div>
  419. <h5 class="parameters">Parameters</h5>
  420. <table class="table table-bordered table-striped table-condensed">
  421. <thead>
  422. <tr>
  423. <th>Type</th>
  424. <th>Name</th>
  425. <th>Description</th>
  426. </tr>
  427. </thead>
  428. <tbody>
  429. <tr>
  430. <td><span class="xref">System.Char</span></td>
  431. <td><span class="parametername">ch</span></td>
  432. <td></td>
  433. </tr>
  434. <tr>
  435. <td><span class="xref">System.Int32</span></td>
  436. <td><span class="parametername">pos</span></td>
  437. <td></td>
  438. </tr>
  439. </tbody>
  440. </table>
  441. <h5 class="returns">Returns</h5>
  442. <table class="table table-bordered table-striped table-condensed">
  443. <thead>
  444. <tr>
  445. <th>Type</th>
  446. <th>Description</th>
  447. </tr>
  448. </thead>
  449. <tbody>
  450. <tr>
  451. <td><span class="xref">System.Boolean</span></td>
  452. <td>true if the character was successfully inserted, otherwise false.</td>
  453. </tr>
  454. </tbody>
  455. </table>
  456. </article>
  457. </div>
  458. <div class="hidden-sm col-md-2" role="complementary">
  459. <div class="sideaffix">
  460. <div class="contribution">
  461. <ul class="nav">
  462. </ul>
  463. </div>
  464. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  465. <h5>In This Article</h5>
  466. <div></div>
  467. </nav>
  468. </div>
  469. </div>
  470. </div>
  471. </div>
  472. <footer>
  473. <div class="grad-bottom"></div>
  474. <div class="footer">
  475. <div class="container">
  476. <span class="pull-right">
  477. <a href="#top">Back to top</a>
  478. </span>
  479. <span>Generated by <strong>DocFX</strong></span>
  480. </div>
  481. </div>
  482. </footer>
  483. </div>
  484. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  485. <script type="text/javascript" src="../../styles/docfx.js"></script>
  486. <script type="text/javascript" src="../../styles/main.js"></script>
  487. </body>
  488. </html>