csharp
/
gui-cs.Terminal.Gui
mirror of https://github.com/gui-cs/Terminal.Gui.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590
							<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class TextField
   </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class TextField
   ">
    <meta name="generator" content="docfx 2.18.2.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="">
    <meta property="docfx:tocrel" content="../toc.html">
    
    
  </head>
  <body data-spy="scroll" data-target="#affix">
    <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="../../logo.svg" 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 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.TextField">
  
  
  <h1 id="Terminal_TextField" data-uid="Terminal.TextField">Class TextField
  </h1>
  <div class="markdown level0 summary"><p>Text data entry widget</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><span class="xref">System.Object</span></div>
    <div class="level1"><a class="xref" href="Terminal.Responder.html">Responder</a></div>
    <div class="level2"><a class="xref" href="Terminal.View.html">View</a></div>
    <div class="level3"><span class="xref">TextField</span></div>
  </div>
  <div class="inheritedMembers">
    <h5>Inherited Members</h5>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_Add_Terminal_View_">View.Add(View)</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_Add_Terminal_View___">View.Add(View[])</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_AddCh_System_Int32_System_Int32_System_Int32_">View.AddCh(Int32, Int32, Int32)</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_Bounds">View.Bounds</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_Clear">View.Clear()</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_DrawFrame_Terminal_Rect_System_Boolean_">View.DrawFrame(Rect, Boolean)</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_DrawHotString_System_String_System_Boolean_Terminal_ColorScheme_">View.DrawHotString(String, Boolean, ColorScheme)</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_DrawHotString_System_String_Terminal_Attribute_Terminal_Attribute_">View.DrawHotString(String, Attribute, Attribute)</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_Driver">View.Driver</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_EnsureFocus">View.EnsureFocus()</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_Focused">View.Focused</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_FocusFirst">View.FocusFirst()</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_FocusLast">View.FocusLast()</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_FocusNext">View.FocusNext()</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_FocusPrev">View.FocusPrev()</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_Frame">View.Frame</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_GetEnumerator">View.GetEnumerator()</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_HasFocus">View.HasFocus</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_Id">View.Id</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_LayoutSubviews">View.LayoutSubviews()</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_MostFocused">View.MostFocused</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_ProcessColdKey_Terminal_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_ProcessHotKey_Terminal_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_Remove_Terminal_View_">View.Remove(View)</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_RemoveAll">View.RemoveAll()</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_SetFocus_Terminal_View_">View.SetFocus(View)</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_SetNeedsDisplay_Terminal_Rect_">View.SetNeedsDisplay(Rect)</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_Subviews">View.Subviews</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_SuperView">View.SuperView</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_ToString">View.ToString()</a>
    </div>
    <div>
      <a class="xref" href="Terminal.View.html#Terminal_View_WantMousePositionReports">View.WantMousePositionReports</a>
    </div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="../Terminal.html">Terminal</a></h6>
  <h6><strong>Assembly</strong>: Terminal.dll</h6>
  <h5 id="Terminal_TextField_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class TextField : Terminal.View</code></pre>
  </div>
  <h5 id="Terminal_TextField_remarks"><strong>Remarks</strong></h5>
  <div class="markdown level0 remarks"><p>The Entry widget provides Emacs-like editing
              functionality,  and mouse support.</p>
</div>
  <h3 id="constructors">Constructors
  </h3>
  
  
  <a id="Terminal_TextField__ctor_" data-uid="Terminal.TextField.#ctor*"></a>
  <h4 id="Terminal_TextField__ctor_System_Int32_System_Int32_System_Int32_System_String_" data-uid="Terminal.TextField.#ctor(System.Int32,System.Int32,System.Int32,System.String)">TextField(Int32, Int32, Int32, String)</h4>
  <div class="markdown level1 summary"><p>Public constructor.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public TextField (int x, int y, int w, string s);</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">x</span></td>
        <td><p>To be added.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Int32</span></td>
        <td><span class="parametername">y</span></td>
        <td><p>To be added.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Int32</span></td>
        <td><span class="parametername">w</span></td>
        <td><p>To be added.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">s</span></td>
        <td><p>To be added.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="properties">Properties
  </h3>
  
  
  <a id="Terminal_TextField_CanFocus_" data-uid="Terminal.TextField.CanFocus*"></a>
  <h4 id="Terminal_TextField_CanFocus" data-uid="Terminal.TextField.CanFocus">CanFocus</h4>
  <div class="markdown level1 summary"></div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override bool CanFocus { 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">System.Boolean</span></td>
        <td><p>To be added.</p>
</td>
      </tr>
    </tbody>
  </table>
  
  
  <a id="Terminal_TextField_Color_" data-uid="Terminal.TextField.Color*"></a>
  <h4 id="Terminal_TextField_Color" data-uid="Terminal.TextField.Color">Color</h4>
  <div class="markdown level1 summary"><p>Sets the color attribute to use (includes foreground and background).</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public Terminal.Attribute Color { 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><a class="xref" href="Terminal.Attribute.html">Attribute</a></td>
        <td><p>The color.</p>
</td>
      </tr>
    </tbody>
  </table>
  
  
  <a id="Terminal_TextField_CursorPosition_" data-uid="Terminal.TextField.CursorPosition*"></a>
  <h4 id="Terminal_TextField_CursorPosition" data-uid="Terminal.TextField.CursorPosition">CursorPosition</h4>
  <div class="markdown level1 summary"><p>The current cursor position.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public int CursorPosition { 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.Int32</span></td>
        <td><p>To be added.</p>
</td>
      </tr>
    </tbody>
  </table>
  
  
  <a id="Terminal_TextField_Secret_" data-uid="Terminal.TextField.Secret*"></a>
  <h4 id="Terminal_TextField_Secret" data-uid="Terminal.TextField.Secret">Secret</h4>
  <div class="markdown level1 summary"><p>Sets the secret property.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool Secret { 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">System.Boolean</span></td>
        <td><p>To be added.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 id="Terminal_TextField_Secret_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>This makes the text entry suitable for entering passwords.</p>
</div>
  
  
  <a id="Terminal_TextField_Text_" data-uid="Terminal.TextField.Text*"></a>
  <h4 id="Terminal_TextField_Text" data-uid="Terminal.TextField.Text">Text</h4>
  <div class="markdown level1 summary"><p>Sets or gets the text in the entry.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public string 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">System.String</span></td>
        <td><p>To be added.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
  </h3>
  
  
  <a id="Terminal_TextField_MouseEvent_" data-uid="Terminal.TextField.MouseEvent*"></a>
  <h4 id="Terminal_TextField_MouseEvent_Terminal_MouseEvent_" data-uid="Terminal.TextField.MouseEvent(Terminal.MouseEvent)">MouseEvent(MouseEvent)</h4>
  <div class="markdown level1 summary"></div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override bool MouseEvent (Terminal.MouseEvent ev);</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><a class="xref" href="Terminal.MouseEvent.html">MouseEvent</a></td>
        <td><span class="parametername">ev</span></td>
        <td><p>To be added.</p>
</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><p>To be added.</p>
</td>
      </tr>
    </tbody>
  </table>
  
  
  <a id="Terminal_TextField_PositionCursor_" data-uid="Terminal.TextField.PositionCursor*"></a>
  <h4 id="Terminal_TextField_PositionCursor" data-uid="Terminal.TextField.PositionCursor">PositionCursor()</h4>
  <div class="markdown level1 summary"><p>Sets the cursor position.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override void PositionCursor ();</code></pre>
  </div>
  
  
  <a id="Terminal_TextField_ProcessKey_" data-uid="Terminal.TextField.ProcessKey*"></a>
  <h4 id="Terminal_TextField_ProcessKey_Terminal_KeyEvent_" data-uid="Terminal.TextField.ProcessKey(Terminal.KeyEvent)">ProcessKey(KeyEvent)</h4>
  <div class="markdown level1 summary"></div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override bool ProcessKey (Terminal.KeyEvent kb);</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><a class="xref" href="Terminal.KeyEvent.html">KeyEvent</a></td>
        <td><span class="parametername">kb</span></td>
        <td><p>To be added.</p>
</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><p>To be added.</p>
</td>
      </tr>
    </tbody>
  </table>
  
  
  <a id="Terminal_TextField_Redraw_" data-uid="Terminal.TextField.Redraw*"></a>
  <h4 id="Terminal_TextField_Redraw_Terminal_Rect_" data-uid="Terminal.TextField.Redraw(Terminal.Rect)">Redraw(Rect)</h4>
  <div class="markdown level1 summary"></div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override void Redraw (Terminal.Rect region);</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><a class="xref" href="Terminal.Rect.html">Rect</a></td>
        <td><span class="parametername">region</span></td>
        <td><p>To be added.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="events">Events
  </h3>
  
  
  <h4 id="Terminal_TextField_Changed" data-uid="Terminal.TextField.Changed">Changed</h4>
  <div class="markdown level1 summary"><p>Changed event, raised when the text has clicked.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public event EventHandler Changed;</code></pre>
  </div>
  <h5 class="eventType">Event Type</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.EventHandler</span></td>
        <td><p>To be added.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 id="Terminal_TextField_Changed_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>Client code can hook up to this event, it is
              raised when the text in the entry changes.</p>
</div>
</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">
              <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
              </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>Copyright © 2015-2017 Microsoft<br>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>