Terminal.Gui.Clipboard.html 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272
  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>Class Clipboard
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Clipboard
  11. ">
  12. <meta name="generator" content="docfx 2.59.3.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. <link href="https://fonts.googleapis.com/css?family=Source Sans Pro" rel="stylesheet">
  18. <link href="https://fonts.googleapis.com/css?family=Source Code Pro" rel="stylesheet">
  19. <meta property="docfx:navrel" content="../../toc.html">
  20. <meta property="docfx:tocrel" content="toc.html">
  21. <meta property="docfx:rel" content="../../">
  22. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  23. <div id="wrapper">
  24. <header>
  25. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  26. <div class="container">
  27. <div class="navbar-header">
  28. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  29. <span class="sr-only">Toggle navigation</span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. </button>
  34. <a class="navbar-brand" href="../../index.html">
  35. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  36. </a>
  37. </div>
  38. <div class="collapse navbar-collapse" id="navbar">
  39. <form class="navbar-form navbar-right" role="search" id="search">
  40. <div class="form-group">
  41. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  42. </div>
  43. </form>
  44. </div>
  45. </div>
  46. </nav>
  47. <div class="subnav navbar navbar-default">
  48. <div class="container hide-when-search" id="breadcrumb">
  49. <ul class="breadcrumb">
  50. <li></li>
  51. </ul>
  52. </div>
  53. </div>
  54. </header>
  55. <div class="container body-content">
  56. <div id="search-results">
  57. <div class="search-list">Search Results for <span></span></div>
  58. <div class="sr-items">
  59. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  60. </div>
  61. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  62. </div>
  63. </div>
  64. <div role="main" class="container body-content hide-when-search">
  65. <div class="sidenav hide-when-search">
  66. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  67. <div class="sidetoggle collapse" id="sidetoggle">
  68. <div id="sidetoc"></div>
  69. </div>
  70. </div>
  71. <div class="article row grid-right">
  72. <div class="col-md-10">
  73. <article class="content wrap" id="_content" data-uid="Terminal.Gui.Clipboard">
  74. <h1 id="Terminal_Gui_Clipboard" data-uid="Terminal.Gui.Clipboard" class="text-break">Class Clipboard
  75. </h1>
  76. <div class="markdown level0 summary">
  77. Provides cut, copy, and paste support for the clipboard with OS interaction.
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <div class="inheritance">
  81. <h5>Inheritance</h5>
  82. <div class="level0"><span class="xref">System.Object</span></div>
  83. <div class="level1"><span class="xref">Clipboard</span></div>
  84. </div>
  85. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  86. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  87. <h5 id="Terminal_Gui_Clipboard_syntax">Syntax</h5>
  88. <div class="codewrapper">
  89. <pre><code class="lang-csharp hljs">public static class Clipboard : Object</code></pre>
  90. </div>
  91. <h3 id="properties">Properties
  92. </h3>
  93. <a id="Terminal_Gui_Clipboard_Contents_" data-uid="Terminal.Gui.Clipboard.Contents*"></a>
  94. <h4 id="Terminal_Gui_Clipboard_Contents" data-uid="Terminal.Gui.Clipboard.Contents">Contents</h4>
  95. <div class="markdown level1 summary">
  96. Get or sets the operation system clipboard, otherwise the contents field.
  97. </div>
  98. <div class="markdown level1 conceptual"></div>
  99. <h5 class="decalaration">Declaration</h5>
  100. <div class="codewrapper">
  101. <pre><code class="lang-csharp hljs">public static ustring Contents { get; set; }</code></pre>
  102. </div>
  103. <h5 class="propertyValue">Property Value</h5>
  104. <table class="table table-bordered table-striped table-condensed">
  105. <thead>
  106. <tr>
  107. <th>Type</th>
  108. <th>Description</th>
  109. </tr>
  110. </thead>
  111. <tbody>
  112. <tr>
  113. <td><span class="xref">NStack.ustring</span></td>
  114. <td></td>
  115. </tr>
  116. </tbody>
  117. </table>
  118. <a id="Terminal_Gui_Clipboard_IsSupported_" data-uid="Terminal.Gui.Clipboard.IsSupported*"></a>
  119. <h4 id="Terminal_Gui_Clipboard_IsSupported" data-uid="Terminal.Gui.Clipboard.IsSupported">IsSupported</h4>
  120. <div class="markdown level1 summary">
  121. Returns true if the environmental dependencies are in place to interact with the OS clipboard.
  122. </div>
  123. <div class="markdown level1 conceptual"></div>
  124. <h5 class="decalaration">Declaration</h5>
  125. <div class="codewrapper">
  126. <pre><code class="lang-csharp hljs">public static bool IsSupported { get; }</code></pre>
  127. </div>
  128. <h5 class="propertyValue">Property Value</h5>
  129. <table class="table table-bordered table-striped table-condensed">
  130. <thead>
  131. <tr>
  132. <th>Type</th>
  133. <th>Description</th>
  134. </tr>
  135. </thead>
  136. <tbody>
  137. <tr>
  138. <td><span class="xref">System.Boolean</span></td>
  139. <td></td>
  140. </tr>
  141. </tbody>
  142. </table>
  143. <h3 id="methods">Methods
  144. </h3>
  145. <a id="Terminal_Gui_Clipboard_TryGetClipboardData_" data-uid="Terminal.Gui.Clipboard.TryGetClipboardData*"></a>
  146. <h4 id="Terminal_Gui_Clipboard_TryGetClipboardData_System_String__" data-uid="Terminal.Gui.Clipboard.TryGetClipboardData(System.String@)">TryGetClipboardData(out String)</h4>
  147. <div class="markdown level1 summary">
  148. Gets the operation system clipboard if possible.
  149. </div>
  150. <div class="markdown level1 conceptual"></div>
  151. <h5 class="decalaration">Declaration</h5>
  152. <div class="codewrapper">
  153. <pre><code class="lang-csharp hljs">public static bool TryGetClipboardData(out string result)</code></pre>
  154. </div>
  155. <h5 class="parameters">Parameters</h5>
  156. <table class="table table-bordered table-striped table-condensed">
  157. <thead>
  158. <tr>
  159. <th>Type</th>
  160. <th>Name</th>
  161. <th>Description</th>
  162. </tr>
  163. </thead>
  164. <tbody>
  165. <tr>
  166. <td><span class="xref">System.String</span></td>
  167. <td><span class="parametername">result</span></td>
  168. <td>Clipboard contents read</td>
  169. </tr>
  170. </tbody>
  171. </table>
  172. <h5 class="returns">Returns</h5>
  173. <table class="table table-bordered table-striped table-condensed">
  174. <thead>
  175. <tr>
  176. <th>Type</th>
  177. <th>Description</th>
  178. </tr>
  179. </thead>
  180. <tbody>
  181. <tr>
  182. <td><span class="xref">System.Boolean</span></td>
  183. <td>true if it was possible to read the OS clipboard.</td>
  184. </tr>
  185. </tbody>
  186. </table>
  187. <a id="Terminal_Gui_Clipboard_TrySetClipboardData_" data-uid="Terminal.Gui.Clipboard.TrySetClipboardData*"></a>
  188. <h4 id="Terminal_Gui_Clipboard_TrySetClipboardData_System_String_" data-uid="Terminal.Gui.Clipboard.TrySetClipboardData(System.String)">TrySetClipboardData(String)</h4>
  189. <div class="markdown level1 summary">
  190. Sets the operation system clipboard if possible.
  191. </div>
  192. <div class="markdown level1 conceptual"></div>
  193. <h5 class="decalaration">Declaration</h5>
  194. <div class="codewrapper">
  195. <pre><code class="lang-csharp hljs">public static bool TrySetClipboardData(string text)</code></pre>
  196. </div>
  197. <h5 class="parameters">Parameters</h5>
  198. <table class="table table-bordered table-striped table-condensed">
  199. <thead>
  200. <tr>
  201. <th>Type</th>
  202. <th>Name</th>
  203. <th>Description</th>
  204. </tr>
  205. </thead>
  206. <tbody>
  207. <tr>
  208. <td><span class="xref">System.String</span></td>
  209. <td><span class="parametername">text</span></td>
  210. <td></td>
  211. </tr>
  212. </tbody>
  213. </table>
  214. <h5 class="returns">Returns</h5>
  215. <table class="table table-bordered table-striped table-condensed">
  216. <thead>
  217. <tr>
  218. <th>Type</th>
  219. <th>Description</th>
  220. </tr>
  221. </thead>
  222. <tbody>
  223. <tr>
  224. <td><span class="xref">System.Boolean</span></td>
  225. <td>True if the clipboard content was set successfully.</td>
  226. </tr>
  227. </tbody>
  228. </table>
  229. </article>
  230. </div>
  231. <div class="hidden-sm col-md-2" role="complementary">
  232. <div class="sideaffix">
  233. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  234. <h5>In This Article</h5>
  235. <div></div>
  236. </nav>
  237. </div>
  238. </div>
  239. </div>
  240. </div>
  241. <footer>
  242. <div class="grad-bottom"></div>
  243. <div class="footer">
  244. <div class="container">
  245. <span class="pull-right">
  246. <a href="#top">Back to top</a>
  247. </span>
  248. <span>Generated by <strong>DocFX</strong></span>
  249. </div>
  250. </div>
  251. </footer>
  252. </div>
  253. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  254. <script type="text/javascript" src="../../styles/docfx.js"></script>
  255. <script type="text/javascript" src="../../styles/main.js"></script>
  256. </body>
  257. </html>