Export (0) Print
Expand All

Clipboard.SetDataObject Method (Object, Boolean, Int32, Int32)

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)

[UIPermissionAttribute(SecurityAction.Demand, Clipboard = UIPermissionClipboard.OwnClipboard)]
public 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.

ExceptionCondition
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.

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.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft