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: Single Thread Apartment) モードになっていません。 アプリケーションの Main メソッドに STAThreadAttribute を追加してください。

次の例では、このメンバーを示します。

// 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 (シングル スレッド アパートメント) モードに設定されたスレッドでのみ使用できます。 このクラスを使用するには、お使いの Main メソッドが STAThreadAttribute 属性でマークされているようにします。

このメソッドを SetData 使用して、特定の形式でクリップボードにデータを追加します。

適用対象

こちらもご覧ください