Clipboard::SetDataObject Method (Object^, Boolean, Int32, Int32)

 
System_CAPS_noteNote

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

Clears the Clipboard and then attempts to place data on it the specified number of times and with the specified delay between attempts, optionally leaving the data on the Clipboard after the application exits.

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

public:
[UIPermissionAttribute(SecurityAction::Demand, Clipboard = UIPermissionClipboard::OwnClipboard)]
static void SetDataObject(
	Object^ data,
	bool copy,
	int retryTimes,
	int retryDelay
)

Parameters

data
Type: System::Object^

The data to place on the Clipboard.

copy
Type: System::Boolean

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

retryTimes
Type: System::Int32

The number of times to attempt placing the data on the Clipboard.

retryDelay
Type: System::Int32

The number of milliseconds to pause between attempts.

Exception Condition
ThreadStateException

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

ArgumentNullException

data is null.

ArgumentOutOfRangeException

retryTimes is less than zero.

-or-

retryDelay is less than zero.

ExternalException

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

Adding data to the Clipboard can occasionally fail if the Clipboard is busy with another thread or application. This method is useful to work around this issue in environments with heavy Clipboard use.

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

System_CAPS_noteNote

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.

UIPermission

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

UIPermission

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

.NET Framework
Available since 2.0
Return to top
Show: