Clipboard.GetData メソッド

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

Clipboard.GetData メソッド

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

クリップボードから指定した形式でデータを取得します。

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

Visual Basic (宣言)

Public Shared Function GetData
 ( _
    format As String _
) As Object

Visual Basic (使用法)

Dim format As String
Dim returnValue As Object

returnValue = Clipboard.GetData(format)

C#

public static Object GetData (
    string format
)

C++

public:
static Object^ GetData (
    String^ format
)

J#

public static Object GetData (
    String format
)

JScript

public static function GetData
 (
    format : String
) : Object

パラメータ

format

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

戻り値
クリップボードのデータを表す Object。指定した format のデータ、またはその形式に変換できるデータがクリップボードに含まれていない場合は null 参照 (Visual Basic では Nothing)。

例外

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

解説

このメソッドを使用して、指定した形式または互換性のある形式のデータを取得する前に、その形式のデータがクリップボードに含まれているかどうかを確認するには、ContainsData メソッドを使用します。

指定した形式のデータが見つからない場合、このメソッドはデータをその形式に変換しようとします。データを指定した形式に変換できない場合や、データの格納時に自動変換に false が設定されていた場合は、このメソッドは null 参照 (Visual Basic では Nothing) を返します。

メモ
形式変換を有効にしてデータが格納されている場合、要求した形式が、格納されている形式と互換性があれば、そのデータを別の形式に変換できます。たとえば、Unicode として格納されたデータをテキストに変換できます。 Clipboard クラスは、シングル スレッド アパートメント (STA: Single Thread Apartment) モードに設定されているスレッドでだけ使用できます。このクラスを使用するには、Main メソッドが確実に STAThreadAttribute 属性でマークされているようにします。

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

使用例

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

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  (システム クリップボードにアクセスするために必要なアクセス許可)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 名前空間
Object
DataFormats
ContainsData
SetData