csharp
/
gui-cs.Terminal.Gui
зеркало из https://github.com/gui-cs/Terminal.Gui.git


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618
							<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

  <head>
    <meta charset="utf-8">
      <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
      <title>Enum Key
 </title>
      <meta name="viewport" content="width=device-width">
      <meta name="title" content="Enum Key
 ">
    
      <link rel="shortcut icon" href="../../favicon.ico">
      <link rel="stylesheet" href="../../styles/docfx.vendor.min.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.Key">


  <h1 id="Terminal_Gui_Key" data-uid="Terminal.Gui.Key" class="text-break">Enum Key
</h1>
  <div class="markdown level0 summary">The <a class="xref" href="Terminal.Gui.Key.html">Key</a> enumeration contains special encoding for some keys, but can also
encode all the unicode values that can be passed.</div>
  <div class="markdown level0 conceptual"></div>
  <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.html">Terminal</a>.<a class="xref" href="Terminal.Gui.html">Gui</a></h6>
  <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  <h5 id="Terminal_Gui_Key_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">[Flags]
public enum Key : uint</code></pre>
  </div>
  <h5 id="Terminal_Gui_Key_remarks"><strong>Remarks</strong></h5>
  <div class="markdown level0 remarks"><p>
  If the <a class="xref" href="Terminal.Gui.Key.html#Terminal_Gui_Key_SpecialMask">SpecialMask</a> is set, then the value is that of the special mask,
  otherwise, the value is the one of the lower bits (as extracted by <a class="xref" href="Terminal.Gui.Key.html#Terminal_Gui_Key_CharMask">CharMask</a>)
<p>
  Numerics keys are the values between 48 and 57 corresponding to 0 to 9
</p>

<p>
  Upper alpha keys are the values between 65 and 90 corresponding to A to Z
</p>
<p>
  Unicode runes are also stored here, the letter 'A" for example is encoded as a value 65 (not surfaced in the enum).
</p></div>
  <h3 id="fields">Fields
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    <thead>
    <tbody>
      <tr>
        <td id="Terminal_Gui_Key_A">A</td>
        <td>The key code for the user pressing Shift-A</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_AltMask">AltMask</td>
        <td>When this value is set, the Key encodes the sequence Alt-KeyValue.
And the actual value must be extracted by removing the AltMask.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_B">B</td>
        <td>The key code for the user pressing Shift-B</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_BackTab">BackTab</td>
        <td>Shift-tab key (backwards tab key).</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_Backspace">Backspace</td>
        <td>Backspace key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_C">C</td>
        <td>The key code for the user pressing Shift-C</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_CharMask">CharMask</td>
        <td>Mask that indicates that this is a character value, values outside this range
indicate special characters like Alt-key combinations or special keys on the
keyboard like function keys, arrows keys and so on.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_Clear">Clear</td>
        <td>The key code for the user pressing the clear key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_CtrlMask">CtrlMask</td>
        <td>When this value is set, the Key encodes the sequence Ctrl-KeyValue.
And the actual value must be extracted by removing the CtrlMask.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_CursorDown">CursorDown</td>
        <td>Cursor down key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_CursorLeft">CursorLeft</td>
        <td>Cursor left key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_CursorRight">CursorRight</td>
        <td>Cursor right key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_CursorUp">CursorUp</td>
        <td>Cursor up key</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_D">D</td>
        <td>The key code for the user pressing Shift-D</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_D0">D0</td>
        <td>Digit 0.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_D1">D1</td>
        <td>Digit 1.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_D2">D2</td>
        <td>Digit 2.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_D3">D3</td>
        <td>Digit 3.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_D4">D4</td>
        <td>Digit 4.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_D5">D5</td>
        <td>Digit 5.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_D6">D6</td>
        <td>Digit 6.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_D7">D7</td>
        <td>Digit 7.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_D8">D8</td>
        <td>Digit 8.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_D9">D9</td>
        <td>Digit 9.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_Delete">Delete</td>
        <td>The key code for the user pressing the delete key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_DeleteChar">DeleteChar</td>
        <td>Delete character key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_E">E</td>
        <td>The key code for the user pressing Shift-E</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_End">End</td>
        <td>End key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_Enter">Enter</td>
        <td>The key code for the user pressing the return key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_Esc">Esc</td>
        <td>The key code for the user pressing the escape key</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F">F</td>
        <td>The key code for the user pressing Shift-F</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F1">F1</td>
        <td>F1 key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F10">F10</td>
        <td>F10 key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F11">F11</td>
        <td>F11 key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F12">F12</td>
        <td>F12 key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F13">F13</td>
        <td>F13 key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F14">F14</td>
        <td>F14 key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F15">F15</td>
        <td>F15 key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F16">F16</td>
        <td>F16 key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F17">F17</td>
        <td>F17 key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F18">F18</td>
        <td>F18 key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F19">F19</td>
        <td>F19 key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F2">F2</td>
        <td>F2 key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F20">F20</td>
        <td>F20 key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F21">F21</td>
        <td>F21 key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F22">F22</td>
        <td>F22 key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F23">F23</td>
        <td>F23 key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F24">F24</td>
        <td>F24 key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F3">F3</td>
        <td>F3 key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F4">F4</td>
        <td>F4 key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F5">F5</td>
        <td>F5 key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F6">F6</td>
        <td>F6 key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F7">F7</td>
        <td>F7 key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F8">F8</td>
        <td>F8 key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_F9">F9</td>
        <td>F9 key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_G">G</td>
        <td>The key code for the user pressing Shift-G</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_H">H</td>
        <td>The key code for the user pressing Shift-H</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_Home">Home</td>
        <td>Home key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_I">I</td>
        <td>The key code for the user pressing Shift-I</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_InsertChar">InsertChar</td>
        <td>Insert character key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_J">J</td>
        <td>The key code for the user pressing Shift-J</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_K">K</td>
        <td>The key code for the user pressing Shift-K</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_L">L</td>
        <td>The key code for the user pressing Shift-L</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_M">M</td>
        <td>The key code for the user pressing Shift-M</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_N">N</td>
        <td>The key code for the user pressing Shift-N</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_Null">Null</td>
        <td>The key code representing null or empty</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_O">O</td>
        <td>The key code for the user pressing Shift-O</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_P">P</td>
        <td>The key code for the user pressing Shift-P</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_PageDown">PageDown</td>
        <td>Page Down key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_PageUp">PageUp</td>
        <td>Page Up key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_PrintScreen">PrintScreen</td>
        <td>Print screen character key.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_Q">Q</td>
        <td>The key code for the user pressing Shift-Q</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_R">R</td>
        <td>The key code for the user pressing Shift-R</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_S">S</td>
        <td>The key code for the user pressing Shift-S</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_ShiftMask">ShiftMask</td>
        <td>When this value is set, the Key encodes the sequence Shift-KeyValue.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_Space">Space</td>
        <td>The key code for the user pressing the space bar</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_SpecialMask">SpecialMask</td>
        <td>If the <a class="xref" href="Terminal.Gui.Key.html#Terminal_Gui_Key_SpecialMask">SpecialMask</a> is set, then the value is that of the special mask,
otherwise, the value is the one of the lower bits (as extracted by <a class="xref" href="Terminal.Gui.Key.html#Terminal_Gui_Key_CharMask">CharMask</a>).</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_T">T</td>
        <td>The key code for the user pressing Shift-T</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_Tab">Tab</td>
        <td>The key code for the user pressing the tab key (forwards tab key).</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_U">U</td>
        <td>The key code for the user pressing Shift-U</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_Unknown">Unknown</td>
        <td>A key with an unknown mapping was raised.</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_V">V</td>
        <td>The key code for the user pressing Shift-V</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_W">W</td>
        <td>The key code for the user pressing Shift-W</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_X">X</td>
        <td>The key code for the user pressing Shift-X</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_Y">Y</td>
        <td>The key code for the user pressing Shift-Y</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_Z">Z</td>
        <td>The key code for the user pressing Shift-Z</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_a">a</td>
        <td>The key code for the user pressing A</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_b">b</td>
        <td>The key code for the user pressing B</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_c">c</td>
        <td>The key code for the user pressing C</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_d">d</td>
        <td>The key code for the user pressing D</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_e">e</td>
        <td>The key code for the user pressing E</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_f">f</td>
        <td>The key code for the user pressing F</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_g">g</td>
        <td>The key code for the user pressing G</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_h">h</td>
        <td>The key code for the user pressing H</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_i">i</td>
        <td>The key code for the user pressing I</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_j">j</td>
        <td>The key code for the user pressing J</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_k">k</td>
        <td>The key code for the user pressing K</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_l">l</td>
        <td>The key code for the user pressing L</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_m">m</td>
        <td>The key code for the user pressing M</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_n">n</td>
        <td>The key code for the user pressing N</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_o">o</td>
        <td>The key code for the user pressing O</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_p">p</td>
        <td>The key code for the user pressing P</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_q">q</td>
        <td>The key code for the user pressing Q</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_r">r</td>
        <td>The key code for the user pressing R</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_s">s</td>
        <td>The key code for the user pressing S</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_t">t</td>
        <td>The key code for the user pressing T</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_u">u</td>
        <td>The key code for the user pressing U</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_v">v</td>
        <td>The key code for the user pressing V</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_w">w</td>
        <td>The key code for the user pressing W</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_x">x</td>
        <td>The key code for the user pressing X</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_y">y</td>
        <td>The key code for the user pressing Y</td>
      </tr>
      <tr>
        <td id="Terminal_Gui_Key_z">z</td>
        <td>The key code for the user pressing Z</td>
      </tr>
    </tbody>
  </thead></thead></table>
</article>
          </div>

          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                  <li>
                    <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Key.md&amp;value=---%0Auid%3A%20Terminal.Gui.Key%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Edit this page</a>
                  </li>
                  <li>
                    <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Event.cs/#L60" class="contribution-link">View Source</a>
                  </li>
                </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.min.js"></script>
    <script type="text/javascript" src="../../styles/docfx.js"></script>
    <script type="text/javascript" src="../../styles/main.js"></script>
  </body>
</html>