Clipboard.ContainsImage Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Indicates whether there is data on the Clipboard that is in the Bitmap format or can be converted to that format.
public:
static bool ContainsImage();public static bool ContainsImage ();static member ContainsImage : unit -> boolPublic Shared Function ContainsImage () As BooleanReturns
true if there is image data on the Clipboard; otherwise, false.
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 this 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.
