This topic has not yet been rated - Rate this topic

Clipboard.SetImage Method

.NET Framework 4

Other Versions

Clears the Clipboard and then adds an Image in the Bitmap format.

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

Syntax

C++

Copy

public static void SetImage(
	Image image
)

Parameters

image: Type: System.Drawing.Image
The Image to add to the Clipboard.

Exceptions

Exception	Condition
ExternalException	The Clipboard could not be cleared. This typically occurs when the Clipboard is being used by another process.
ThreadStateException	The current thread is not in single-threaded apartment (STA) mode. Add the STAThreadAttribute to your application's Main method.
ArgumentNullException	image is null.

Remarks

To retrieve image data from the Clipboard, first use the ContainsImage method to determine whether the Clipboard contains image data before retrieving it with the GetImage method.

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

Examples

The following example demonstrates this member.

Copy


// Demonstrates SetImage, ContainsImage, and GetImage.
public System.Drawing.Image SwapClipboardImage(
    System.Drawing.Image replacementImage)
{
    System.Drawing.Image returnImage = null;
    if (Clipboard.ContainsImage())
    {
        returnImage = Clipboard.GetImage();
        Clipboard.SetImage(replacementImage);
    }
    return returnImage;
}

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET Framework Security

UIPermission
for adding data in the Bitmap format to the system Clipboard. Associated enumeration: UIPermissionClipboard.AllClipboard

Platforms

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.

Reference

Clipboard Class

System.Windows.Forms Namespace

Bitmap

ContainsImage

GetImage

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ