Clipboard.GetImage 方法

定义

命名空间:

System.Windows.Forms

程序集:

System.Windows.Forms.dll

检索剪贴板上的图像。

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

返回

Image

表示剪贴板图像数据的 Image；如果剪贴板中不包含任何 Bitmap 格式或可转换成该格式的数据，则为 null。

例外

ExternalException

未能清空剪贴板。 这种情况通常发生在剪贴板正在被其他进程使用的时候。

ThreadStateException

当前线程未处于单线程单元 (STA) 模式下。 请将 STAThreadAttribute 添加到应用程序的 Main 方法中。

示例

以下示例演示此成员。

// 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

注解

ContainsImage在使用此方法检索剪贴板数据之前，使用 方法确定剪贴板是否包含图像数据。

SetImage使用 方法将图像数据添加到剪贴板。

注意

Clipboard 类只能在设置为单线程单元 (STA) 模式的线程中使用。 若要使用此类，请确保使用 Main 特性标记 STAThreadAttribute 方法。

另请参阅

• Image
• Bitmap
• ContainsImage()
• SetImage(Image)