Clipboard.GetData(String) 方法

定義

命名空間:

System.Windows.Forms

組件:

System.Windows.Forms.dll

從剪貼簿擷取指定格式的資料。

public:
 static System::Object ^ GetData(System::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

如果剪貼簿不包含任何指定 format 或可以轉換為該格式的資料，則為代表剪貼簿資料或 null 的 Object。

例外狀況

ExternalException

無法清除剪貼簿。 這通常在剪貼簿由另一個處理序使用時發生。

ThreadStateException

目前執行緒 (Thread) 不是在單一執行緒 Apartment (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 只能用於設定為單一線程 Apartment (STA) 模式的執行緒。 若要使用此類別，請確定您的 Main 方法已以 STAThreadAttribute 屬性標示。

使用 方法，以特定格式將資料新增至剪 SetData 貼簿。

另請參閱

• Object
• DataFormats
• ContainsData(String)
• SetData(String, Object)