Terminal.Gui.Clipboard.html 10 KB

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