mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-27 16:27:55 +01:00
7f27d78cc7
* tweaked version # for v1.0.0-beta.10 * tweaked version # for v1.0.0-beta.11 * Updated readme and revision history for 1.0 * tweaked rel notes * Regenerated docs for v1.0.0.0 * updating build docs * updating docs * updated readme * updated readme * more docs * more docs * Refactored for clarity * tweaks * updated info on versioning * merged with main. updated relnotes * updated api docs * updated README to point to new docs * merged from future v1.0.0 branch * regen apidocs * add code coverage badge generation to publish * add code coverage badge generation to publish * tweaked badge
528 lines
19 KiB
HTML
528 lines
19 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Interface ITextValidateProvider
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Interface ITextValidateProvider
|
|
">
|
|
<meta name="generator" content="docfx 2.56.7.0">
|
|
|
|
<link rel="shortcut icon" href="../../favicon.ico">
|
|
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../../styles/docfx.css">
|
|
<link rel="stylesheet" href="../../styles/main.css">
|
|
<meta property="docfx:navrel" content="../../toc.html">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
<meta property="docfx:rel" content="../../">
|
|
|
|
</head>
|
|
<body data-spy="scroll" data-target="#affix" data-offset="120">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../../index.html">
|
|
<img id="logo" class="svg" src="../../images/logo48.png" alt="">
|
|
</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container body-content">
|
|
|
|
<div id="search-results">
|
|
<div class="search-list">Search Results for <span></span></div>
|
|
<div class="sr-items">
|
|
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
|
|
</div>
|
|
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
|
|
</div>
|
|
</div>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider">
|
|
|
|
|
|
<h1 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider" class="text-break">Interface ITextValidateProvider
|
|
</h1>
|
|
<div class="markdown level0 summary">
|
|
TextValidateField Providers Interface.
|
|
All TextValidateField are created with a ITextValidateProvider.
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.TextValidateProviders.html">Terminal.Gui.TextValidateProviders</a></h6>
|
|
<h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
|
|
<h5 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public interface ITextValidateProvider</code></pre>
|
|
</div>
|
|
<h3 id="properties">Properties
|
|
</h3>
|
|
|
|
|
|
<a id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_Fixed_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.Fixed*"></a>
|
|
<h4 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_Fixed" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.Fixed">Fixed</h4>
|
|
<div class="markdown level1 summary">
|
|
Set that this provider uses a fixed width.
|
|
e.g. Masked ones are fixed.
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">bool Fixed { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_IsValid_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.IsValid*"></a>
|
|
<h4 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_IsValid" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.IsValid">IsValid</h4>
|
|
<div class="markdown level1 summary">
|
|
True if the input is valid, otherwise false.
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">bool IsValid { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_Mask_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.Mask*"></a>
|
|
<h4 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_Mask" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.Mask">Mask</h4>
|
|
<div class="markdown level1 summary">
|
|
Mask used for validation.
|
|
Not always a mask, can by a regex expression.
|
|
TODO: Maybe we can change the name.
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ustring Mask { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">NStack.ustring</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_Text_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.Text*"></a>
|
|
<h4 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_Text" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.Text">Text</h4>
|
|
<div class="markdown level1 summary">
|
|
Set the input text, and get the formatted string for display.
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ustring Text { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">NStack.ustring</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
|
|
|
|
<a id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_Cursor_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.Cursor*"></a>
|
|
<h4 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_Cursor_System_Int32_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.Cursor(System.Int32)">Cursor(Int32)</h4>
|
|
<div class="markdown level1 summary">
|
|
Set Cursor position to <code data-dev-comment-type="paramref" class="paramref">pos</code>.
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">int Cursor(int pos)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">pos</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td>Return first valid position.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_CursorEnd_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.CursorEnd*"></a>
|
|
<h4 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_CursorEnd" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.CursorEnd">CursorEnd()</h4>
|
|
<div class="markdown level1 summary">
|
|
Find the last valid character position.
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">int CursorEnd()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td>New cursor position.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_CursorLeft_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.CursorLeft*"></a>
|
|
<h4 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_CursorLeft_System_Int32_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.CursorLeft(System.Int32)">CursorLeft(Int32)</h4>
|
|
<div class="markdown level1 summary">
|
|
First valid position before <code data-dev-comment-type="paramref" class="paramref">pos</code>.
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">int CursorLeft(int pos)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">pos</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td>New cursor position if any, otherwise returns <code data-dev-comment-type="paramref" class="paramref">pos</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_CursorRight_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.CursorRight*"></a>
|
|
<h4 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_CursorRight_System_Int32_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.CursorRight(System.Int32)">CursorRight(Int32)</h4>
|
|
<div class="markdown level1 summary">
|
|
First valid position after <code data-dev-comment-type="paramref" class="paramref">pos</code>.
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">int CursorRight(int pos)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">pos</span></td>
|
|
<td>Current position.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td>New cursor position if any, otherwise returns <code data-dev-comment-type="paramref" class="paramref">pos</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_CursorStart_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.CursorStart*"></a>
|
|
<h4 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_CursorStart" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.CursorStart">CursorStart()</h4>
|
|
<div class="markdown level1 summary">
|
|
Find the first valid character position.
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">int CursorStart()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td>New cursor position.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_Delete_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.Delete*"></a>
|
|
<h4 id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_Delete_System_Int32_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.Delete(System.Int32)">Delete(Int32)</h4>
|
|
<div class="markdown level1 summary">
|
|
Deletes the current character in <code data-dev-comment-type="paramref" class="paramref">pos</code>.
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">bool Delete(int pos)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">pos</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td>true if the character was successfully removed, otherwise false.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_Gui_TextValidateProviders_ITextValidateProvider_InsertAt_" data-uid="Terminal.Gui.TextValidateProviders.ITextValidateProvider.InsertAt*"></a>
|
|
<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>
|
|
<div class="markdown level1 summary">
|
|
Insert character <code data-dev-comment-type="paramref" class="paramref">ch</code> in position <code data-dev-comment-type="paramref" class="paramref">pos</code>.
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">bool InsertAt(char ch, int pos)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Char</span></td>
|
|
<td><span class="parametername">ch</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">pos</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td>true if the character was successfully inserted, otherwise false.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|
<div class="sideaffix">
|
|
<div class="contribution">
|
|
<ul class="nav">
|
|
</ul>
|
|
</div>
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<h5>In This Article</h5>
|
|
<div></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grad-bottom"></div>
|
|
<div class="footer">
|
|
<div class="container">
|
|
<span class="pull-right">
|
|
<a href="#top">Back to top</a>
|
|
</span>
|
|
|
|
<span>Generated by <strong>DocFX</strong></span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
<script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
|
|
<script type="text/javascript" src="../../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../../styles/main.js"></script>
|
|
</body>
|
|
</html>
|