Clipboard::SetDataObject Method (Object^, Boolean)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Clears the Clipboard and then places data on it and specifies whether the data should remain after the application exits.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

static void SetDataObject(
	Object^ data,
	bool copy


Type: System::Object^

The data to place on the Clipboard.

Type: System::Boolean

true if you want data to remain on the Clipboard after this application exits; otherwise, false.

Exception Condition

Data could not be placed on the Clipboard. This typically occurs when the Clipboard is being used by another process.


The current thread is not in single-threaded apartment (STA) mode. Add the STAThreadAttribute to your application's Main method.


The value of data is null.

If the copy parameter is false, the data will be deleted from system Clipboard when the application exits.

This method attempts to set the data ten times in 100-millisecond intervals, and throws an ExternalException if all attempts are unsuccessful.


An object must be serializable for it to be put on the Clipboard. If you pass a non-serializable object to this method, it will fail without throwing an exception. See System.Runtime.Serialization for more information on serialization.

The Clipboard class can only be used in threads set to single thread apartment (STA) mode. To use this class, ensure that your Main method is marked with the STAThreadAttribute attribute.

The following method is run in an application. It places a persistent copy of the selected text data in the text box on the system Clipboard. This code assumes button1, textBox1, and textBox2 have been created and placed on a form.

   void button1_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
      // Takes the selected text from a text box and puts it on the clipboard.
      if ( !textBox1->SelectedText->Equals( "" ) )
         Clipboard::SetDataObject( textBox1->SelectedText, true );
         textBox2->Text = "No text selected in textBox1";

In a different application, the following method retrieves the text from the system Clipboard and pastes the text into textBox2. This code assumes button2 and textBox2 have been created and placed on a form.

   void button2_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
      // Declares an IDataObject to hold the data returned from the clipboard.
      // Retrieves the data from the clipboard.
      IDataObject^ iData = Clipboard::GetDataObject();

      // Determines whether the data is in a format you can use.
      if ( iData->GetDataPresent( DataFormats::Text ) )

         // Yes it is, so display it in a text box.
         textBox2->Text = (String^)(iData->GetData( DataFormats::Text ));

         // No it is not.
         textBox2->Text = "Could not retrieve data off the clipboard.";


for adding data to the system Clipboard that is of type String or is in one of the following data formats: Text, UnicodeText, or CommaSeparatedValue. Associated enumeration: UIPermissionClipboard::OwnClipboard


for adding data of any type or format to the system Clipboard. Associated enumeration: UIPermissionClipboard::AllClipboard

.NET Framework
Available since 1.1
Return to top