System.Windows.Forms.Clipboard.SetDataObject Method

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.

Syntax

public static void SetDataObject (object data, bool copy, int retryTimes, int retryDelay)

Parameters

data
The data to place on the Clipboard.
copy
true if you want data to remain on the Clipboard after this application exits; otherwise, false.
retryTimes
The number of times to attempt placing the data on the Clipboard.
retryDelay
The number of milliseconds to pause between attempts.

Remarks

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.

Note:

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 System.Windows.Forms.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.

Requirements

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