ClipboardProxy Class

Definition

Namespace:

Microsoft.VisualBasic.MyServices

Assembly:

Microsoft.VisualBasic.Forms.dll

Source:

ClipboardProxy.vb

Provides methods for manipulating the Clipboard.

public ref class ClipboardProxy

public class ClipboardProxy

type ClipboardProxy = class

Public Class ClipboardProxy

Inheritance

Object

ClipboardProxy

Examples

This example reads text from the Clipboard into the string textOnClipboard.

Dim textOnClipboard As String = My.Computer.Clipboard.GetText()

This example will fail if there is no text on the Clipboard.

Remarks

Items moved or copied to the Clipboard persist even after the application is shut down.

Data on the Clipboard can be in any data format, also called a Clipboard format. For a list of predefined formats to use with the Clipboard, see DataFormats. When an item is moved or copied to the Clipboard, items in other formats are cleared. To make other formats persist, use DataObject, which copies everything existing on the current Clipboard, including items pasted from other applications. Place data on the Clipboard in multiple formats to maximize the possibility that a target application, whose format requirements you might not know, can successfully retrieve the data.

Because all Windows applications share the system Clipboard, the contents may change when you switch to another application.

A class must be serializable for it to be put on the Clipboard. For more information, see Serialization - C# or Serialization - Visual Basic.

When accessing the Clipboard remotely, a ThreadStateException is thrown unless the accessing thread operates in STA (single-threaded apartment) mode. To resolve this issue, set the ThreadApartmentState to STA. For more information, see STAThreadAttribute.

For more information, see Storing Data to and Reading from the Clipboard.

Availability by Project Type

Project type	Available
Windows Application	Yes
Class Library	Yes
Console Application	Yes
Windows Control Library	Yes
Web Control Library	No
Windows Service	Yes
Web Site	No

Methods

Clear()	Clears the Clipboard.
ContainsAudio()	Indicates whether the Clipboard contains audio data.
ContainsData(String)	Indicates whether the Clipboard contains data in the specified custom format.
ContainsFileDropList()	Returns a Boolean indicating whether the Clipboard contains a file drop list.
ContainsImage()	Returns a Boolean indicating whether an image is stored on the Clipboard.
ContainsText()	Determines if there is text on the Clipboard.
ContainsText(TextDataFormat)	Determines if there is text on the Clipboard.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetAudioStream()	Retrieves an audio stream from the Clipboard.
GetData(String)	Retrieves data in a custom format from the Clipboard.
GetDataObject()	Retrieves data from the Clipboard as an IDataObject.
GetFileDropList()	Retrieves a collection of strings representing file names from the Clipboard.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetImage()	Retrieves an image from the Clipboard.
GetText()	Retrieves text from the Clipboard.
GetText(TextDataFormat)	Retrieves text from the Clipboard.
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
SetAudio(Byte[])	Writes audio data to the Clipboard.
SetAudio(Stream)	Writes audio data to the Clipboard.
SetData(String, Object)	Writes data in a custom format to the Clipboard.
SetDataObject(DataObject)	Writes a DataObject to the Clipboard.
SetFileDropList(StringCollection)	Writes a collection of strings representing file paths to the Clipboard.
SetImage(Image)	Writes an image to the Clipboard.
SetText(String, TextDataFormat)	Writes text to the Clipboard.
SetText(String)	Writes text to the Clipboard.
ToString()	Returns a string that represents the current object. (Inherited from Object)

See also

• Computer
• Clipboard
• Objects (Visual Basic)