123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437 |
- <!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
- ">
- <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.Gui.Key">
-
-
- <h1 id="Terminal_Gui_Key" data-uid="Terminal.Gui.Key">Enum Key
- </h1>
- <div class="markdown level0 summary"><p>The Key enumeration contains special encoding for some keys, but can also
- encode all the unicode values that can be passed.</p>
- </div>
- <div class="markdown level0 conceptual"></div>
- <h6><strong>Namespace</strong>: <a class="xref" href="../Terminal.Gui.html">Terminal.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">public enum Key</code></pre>
- </div>
- <h5 id="Terminal_Gui_Key_remarks"><strong>Remarks</strong></h5>
- <div class="markdown level0 remarks"><p>
- If the SpecialMask is set, then the value is that of the special mask,
- otherwise, the value is the one of the lower bits (as extracted by CharMask)
- </p>
- <p>
- Control keys are the values between 1 and 26 corresponding to Control-A to Control-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-striped table-condensed">
- <thead>
- <tr>
- <th>Name</th>
- <th>Description</th>
- </tr>
- <thead>
- <tbody>
- <tr>
- <td id="Terminal_Gui_Key_AltMask">AltMask</td>
- <td><p>When this value is set, the Key encodes the sequence Alt-KeyValue.
- And the actual value must be extracted by removing the AltMask.</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_Backspace">Backspace</td>
- <td><p>Backspace key.</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_BackTab">BackTab</td>
- <td><p>Shift-tab key (backwards tab key).</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_CharMask">CharMask</td>
- <td><p>Mask that indictes 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.</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlA">ControlA</td>
- <td><p>The key code for the user pressing Control-A</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlB">ControlB</td>
- <td><p>The key code for the user pressing Control-B</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlC">ControlC</td>
- <td><p>The key code for the user pressing Control-C</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlD">ControlD</td>
- <td><p>The key code for the user pressing Control-D</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlE">ControlE</td>
- <td><p>The key code for the user pressing Control-E</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlF">ControlF</td>
- <td><p>The key code for the user pressing Control-F</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlG">ControlG</td>
- <td><p>The key code for the user pressing Control-G</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlH">ControlH</td>
- <td><p>The key code for the user pressing Control-H</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlI">ControlI</td>
- <td><p>The key code for the user pressing Control-I (same as the tab key).</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlJ">ControlJ</td>
- <td><p>The key code for the user pressing Control-J</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlK">ControlK</td>
- <td><p>The key code for the user pressing Control-K</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlL">ControlL</td>
- <td><p>The key code for the user pressing Control-L</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlM">ControlM</td>
- <td><p>The key code for the user pressing Control-M</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlN">ControlN</td>
- <td><p>The key code for the user pressing Control-N (same as the return key).</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlO">ControlO</td>
- <td><p>The key code for the user pressing Control-O</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlP">ControlP</td>
- <td><p>The key code for the user pressing Control-P</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlQ">ControlQ</td>
- <td><p>The key code for the user pressing Control-Q</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlR">ControlR</td>
- <td><p>The key code for the user pressing Control-R</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlS">ControlS</td>
- <td><p>The key code for the user pressing Control-S</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlSpace">ControlSpace</td>
- <td><p>The key code for the user pressing Control-spacebar</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlT">ControlT</td>
- <td><p>The key code for the user pressing Control-T</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlU">ControlU</td>
- <td><p>The key code for the user pressing Control-U</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlV">ControlV</td>
- <td><p>The key code for the user pressing Control-V</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlW">ControlW</td>
- <td><p>The key code for the user pressing Control-W</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlX">ControlX</td>
- <td><p>The key code for the user pressing Control-X</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlY">ControlY</td>
- <td><p>The key code for the user pressing Control-Y</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_ControlZ">ControlZ</td>
- <td><p>The key code for the user pressing Control-Z</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_CursorDown">CursorDown</td>
- <td><p>Cursor down key.</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_CursorLeft">CursorLeft</td>
- <td><p>Cursor left key.</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_CursorRight">CursorRight</td>
- <td><p>Cursor right key.</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_CursorUp">CursorUp</td>
- <td><p>Cursor up key</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_Delete">Delete</td>
- <td><p>The key code for the user pressing the delete key.</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_DeleteChar">DeleteChar</td>
- <td><p>Delete character key</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_End">End</td>
- <td><p>End key</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_Enter">Enter</td>
- <td><p>The key code for the user pressing the return key.</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_Esc">Esc</td>
- <td><p>The key code for the user pressing the escape key</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_F1">F1</td>
- <td><p>F1 key.</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_F10">F10</td>
- <td><p>F10 key.</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_F2">F2</td>
- <td><p>F2 key.</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_F3">F3</td>
- <td><p>F3 key.</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_F4">F4</td>
- <td><p>F4 key.</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_F5">F5</td>
- <td><p>F5 key.</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_F6">F6</td>
- <td><p>F6 key.</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_F7">F7</td>
- <td><p>F7 key.</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_F8">F8</td>
- <td><p>F8 key.</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_F9">F9</td>
- <td><p>F9 key.</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_Home">Home</td>
- <td><p>Home key</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_InsertChar">InsertChar</td>
- <td><p>Insert character key</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_PageDown">PageDown</td>
- <td><p>Page Down key.</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_PageUp">PageUp</td>
- <td><p>Page Up key.</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_Space">Space</td>
- <td><p>The key code for the user pressing the space bar</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_SpecialMask">SpecialMask</td>
- <td><p>If the SpecialMask is set, then the value is that of the special mask,
- otherwise, the value is the one of the lower bits (as extracted by CharMask).</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_Tab">Tab</td>
- <td><p>The key code for the user pressing the tab key (same as pressing Control-I).</p>
- </td>
- </tr>
- <tr>
- <td id="Terminal_Gui_Key_Unknown">Unknown</td>
- <td><p>A key with an unknown mapping was raised.</p>
- </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">
- </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>
|