Clipboard.GetImage Method

Definition

Retrieves an image from the Clipboard.

public:
 static System::Drawing::Image ^ GetImage();
public static System.Drawing.Image GetImage ();
static member GetImage : unit -> System.Drawing.Image
Public Shared Function GetImage () As Image

Returns

An Image representing the Clipboard image data or null if the Clipboard does not contain any data that is in the Bitmap format or can be converted to that format.

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.

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

Use the ContainsImage method to determine whether the Clipboard contains image data before retrieving it with this method.

Use the SetImage method to add image data to the Clipboard.

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 access to the system Clipboard. Associated enumeration: AllClipboard

Applies to

See also