Clipboard.SetData メソッド

.NET Framework クラス ライブラリ リファレンス

Clipboard.SetData メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Public Shared Sub SetData
 ( _
    format As String, _
    data As Object _
)

Visual Basic (使用法)

Dim format As String
Dim data As Object

Clipboard.SetData(format, data)

C#

public static void SetData
 (
    string format,
    Object data
)

C++

public:
static void SetData (
    String^ format, 
    Object^ data
)

J#

public static void SetData
 (
    String format, 
    Object data
)

JScript

public static function SetData
 (
    format : String, 
    data : Object
)

パラメータ

format

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

data

追加するデータを表す Object。

例外

例外の種類	条件
ExternalException	クリップボードをクリアできませんでした。この例外は、通常、クリップボードが別のプロセスで使用されている場合に発生します。
ThreadStateException	現在のスレッドがシングル スレッド アパートメント (STA: Single Thread Apartment) モードになっていません。アプリケーションの Main メソッドに STAThreadAttribute を追加してください。
ArgumentNullException	data が null 参照 (Visual Basic では Nothing) です。

解説

データを取り出す側のアプリケーションの形式が不明な場合は、このメソッドを使用して、データを複数の形式で格納しておくことができます。

このメソッドを使用して格納されたデータは、取得時に互換性のある形式に変換できます。

クリップボードから特定の形式でデータを取得するには、GetData メソッドを使用してそのデータを取得する前に、まず ContainsData メソッドを使用してその形式のデータがクリップボードに含まれているかどうかを確認します。

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

使用例

このメンバの使用例を次に示します。

Visual Basic

' 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

C#

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

.NET Framework のセキュリティ

• UIPermission  (String 型か、Text、UnicodeText、または CommaSeparatedValue のいずれかのデータ形式のデータをシステム クリップボードに追加するために必要なアクセス許可)UIPermissionClipboard.OwnClipboard (関連する列挙体)
• UIPermission  (すべての型または形式のデータをシステム クリップボードに追加するために必要なアクセス許可)UIPermissionClipboard.AllClipboard (関連する列挙体)

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
Clipboard クラス
Clipboard メンバ
System.Windows.Forms 名前空間
DataFormats
ContainsData
GetData