Clipboard.SetImage(Image) Method

Definition

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

public:
 static void SetImage(System::Drawing::Image ^ image);
public static void SetImage (System.Drawing.Image image);
static member SetImage : System.Drawing.Image -> unit

Parameters

image
Image

The Image to add to the Clipboard.

Exceptions

The Clipboard could not be cleared. 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.

image is null.

Examples

The following example demonstrates this member.

// 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;
}
' Demonstrates SetImage, ContainsImage, and GetImage.
Public Function SwapClipboardImage( _
    ByVal replacementImage As System.Drawing.Image) _
    As System.Drawing.Image

    Dim returnImage As System.Drawing.Image = Nothing

    If Clipboard.ContainsImage() Then
        returnImage = Clipboard.GetImage()
        Clipboard.SetImage(replacementImage)
    End If

    Return returnImage
End Function

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.

Security

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

Applies to

See also