Clipboard.SetData(String, Object) メソッド

定義

クリップボードをクリアし、データを指定した形式で追加します。

public:
 static void SetData(System::String ^ format, System::Object ^ data);
public static void SetData (string format, object data);
static member SetData : string * obj -> unit
Public Shared Sub SetData (format As String, data As Object)

パラメーター

format
String

設定するデータの形式。 定義済みの形式については、DataFormats のトピックを参照してください。

data
Object

追加するデータを表す Object

例外

クリップボードをクリアできませんでした。 この例外は、通常、クリップボードが別のプロセスで使用されている場合に発生します。

現在のスレッドがシングル スレッド アパートメント (STA: Single Thread Apartment) モードになっていません。 アプリケーションの Main メソッドに STAThreadAttribute を追加してください。

datanullです。

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

// 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 使用して取得する前 GetData に、 メソッドを使用してクリップボードにその形式のデータが含まれているかどうかを判断します。

注意

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

適用対象

こちらもご覧ください