View source for Clipboard

{{ClassBox
| super=[[Object]]
| platform=all
| scope=global
| project=Desktop, Mobile (iOS)
}}
{{Description
|text=Used to read and write information to and from the Clipboard.
}}

<dynamicTable id="Properties" class="propertyTable" title="Properties" columns="3">
{{Property | name=Picture | type=Picture | platform=all | description=( Picture)&nbsp;&nbsp;The picture on the Clipboard. }}
{{Property | name=Text | type=String | platform=all | description=( String)&nbsp;&nbsp;The text on the Clipboard. }}
</dynamicTable>

<dynamicTable id="Methods" class="methodTable" title="Methods" columns="3">
{{Method | name=Close | description=Close()&#10;Closes the Clipboard.  }}
{{Method | name=PictureAvailable | platform=all | description=PictureAvailable As Boolean&#10;Returns True if the Clipboard contains a picture.}}
{{Method | name=RawData | description=RawData ( DataType as String ) As String&#10;Gets and sets the binary data from the Clipboard as a String for the specified type. }}
{{Method | name=RawDataAvailable | params=MacType as [[String]] | returntype=[[Boolean]] | newinversion=2005r1 | description=RawDataAvailable ( DataType as String ) As Boolean&#10;Returns True if the Clipboard contains data. }}
{{Method | name=TextAvailable | returntype=[[Boolean]] | description=TextAvailable() as Boolean&#10;Returns True if the data on the Clipboard is text. }}
</dynamicTable>

==Notes==
In order to read text from or write text to the Clipboard, you must create an object of type '''Clipboard''' and then access the Text or Picture properties of the Clipboard object you create. You can place a picture on the Clipboard by setting the Picture property. You can use the SetText and AddRawData methods to write text or binary data to the Clipboard. The [[Clipboard]] class is not available to Console applications.

For best results, create a new Clipboard object each time you need to use the clipboard.

The '''Clipboard''' supports [[UTI]]s ([[UserGuide:Uniform_Type_Identifiers|Uniform Type Identifiers]]).

For iOS, only Text is currently supported.

== Sample Code ==
This code gets the text on the Clipboard and copies it to a variable:
<rbcode>
Var c As New Clipboard
Var s As String
s = c.Text
c.Close
</rbcode>

This code puts text on the Clipboard:
<rbcode>
Var c As New Clipboard
c.Text = "The Quick Brown Fox outran the Lazy Dog"
c.Close
</rbcode>

This code checks to see if the Clipboard is text data and if so, copies the contents of the clipboard to a [[TextField]]:
<rbcode>
Var c As New Clipboard
If c.TextAvailable Then
  TextField1.Text = c.Text
End If
c.Close
</rbcode>

This code copies an image to the Clipboard:
<rbcode>
Var c As New Clipboard
If ImageWell1.Image <> Nil Then
  c.Picture = ImageWell1.Image
  c.Close
Else
  MessageBox("No picture is available!")
End If
</rbcode>

When you want to put more than one item on the clipboard, you can't use the properties of this class to append new text or graphics to existing material. You need to do the appending in your code and just use one call to the Text property:
<rbcode>
Var text1 As String = "This is the first item being put on the clipboard!"
Var text2 As String = "This is the second item being put on the clipboard"
Var c As New Clipboard
c.Text = text1 + text2
c.Close
</rbcode>

==Compatibility==
Desktop and iOS project types on all desktop, iOS and iPadOS operating systems.

[[Category:Desktop]]
[[Category:Mobile]]
[[Category:Language_OS]]