Clipboard

From Xojo Documentation
Jump to: navigation, search

Class (inherits from Object)

Used to read and write information to and from the Clipboard.


Properties
Picture PictureAvailable ReadOnlyProperty.png Text


Methods
AddRawData RawData SetText
Close RawDataAvailable TextAvailable


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.

The Clipboard supports UTIs (Uniform Type Identifiers).


Examples

This example gets the text on the Clipboard and copies it to a variable.

Dim c As New Clipboard
Dim s As String
s = c.Text
c.Close


This example puts text on the Clipboard.

Dim c As New Clipboard
c.Text = "The Quick Brown Fox outran the Lazy Dog"
c.Close


This example checks to see if the Clipboard is text data and if so, copies the contents of the clipboard to a TextField.

Dim c As New Clipboard
If c.TextAvailable Then
TextField1.Text = c.Text
End If
c.Close


This example copies an image to the Clipboard:

Dim c As New Clipboard
If ImageWell1.Image <> Nil Then
c.Picture = ImageWell1.Image
c.Close
Else
MsgBox("No picture is available!")
End If


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. That is, the following code won't put both text strings on the Clipboard:

Dim text1 As String = "This is the first item being put on the clipboard!"
Dim text2 As String = "This is the second item being put on the clipboard"
Dim c As New Clipboard
c.Text = text1
c.Text = text2 // Overwrites first text
c.Close


You need to do the appending in your code and just use one call to the Text property:

Dim text1 As String = "This is the first item being put on the clipboard!"
Dim text2 As String = "This is the second item being put on the clipboard"
Dim c As New Clipboard
c.Text = text1 + text2
c.Close
Personal tools
Namespaces

Variants
Actions
Main
Content
Starting Out
Dig Deeper
More Help
Toolbox
About