Clipboard.GetData(String) 方法

定义

从剪贴板中检索指定格式的数据。

public:
 static System::Object ^ GetData(System::String ^ format);
public static object GetData (string format);
public static object? GetData (string format);
static member GetData : string -> obj
Public Shared Function GetData (format As String) As Object

参数

format
String

要检索的数据的格式。 请参见 DataFormats 以获取预定义的格式。

返回

Object

表示剪贴板数据的 Object;如果剪贴板中包含的数据都不是指定 format,也无法转换为该格式,则为 null

例外

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

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

示例

以下示例演示此成员。

// Demonstrates SetData, ContainsData, and GetData.
public Object SwapClipboardFormattedData(String format, Object data)
{
    Object returnObject = null;
    if (Clipboard.ContainsData(format))
    {
        returnObject = Clipboard.GetData(format);
        Clipboard.SetData(format, data);
    }
    return returnObject;
}
' Demonstrates SetData, ContainsData, and GetData.
Public Function SwapClipboardFormattedData( _
    ByVal format As String, ByVal data As Object) As Object

    Dim returnObject As Object = Nothing

    If (Clipboard.ContainsData(format)) Then
        returnObject = Clipboard.GetData(format)
        Clipboard.SetData(format, data)
    End If

    Return returnObject

End Function

注解

ContainsData使用此方法确定剪贴板在使用此方法检索数据之前是采用指定格式还是兼容格式的数据。

如果此方法找不到指定格式的数据,则尝试将数据转换为格式。 如果无法将数据转换为指定的格式,或者数据是使用自动转换设置为 false存储的,则此方法返回 null

备注

如果数据存储指定允许转换,并且所请求的格式与存储格式兼容,则可以将数据转换为另一种格式。 例如,存储为 Unicode 的数据可以转换为文本。

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

SetData使用此方法以特定格式将数据添加到剪贴板。

适用于

另请参阅