Clipboard.ContainsData メソッドとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

Clipboard.ContainsData メソッド

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

指定した形式のデータ、またはその形式に変換できるデータがクリップボードに存在するかどうかを示します。

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

Visual Basic (宣言)

Public Shared Function ContainsData
 ( _
    format As String _
) As Boolean

Visual Basic (使用法)

Dim format As String
Dim returnValue As Boolean

returnValue = Clipboard.ContainsData(format)

public static bool ContainsData
 (
    string format
)

C++

public:
static bool ContainsData (
    String^ format
)

public static boolean ContainsData (
    String format
)

JScript

public static function ContainsData
 (
    format : String
) : boolean

パラメータ

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

戻り値
指定した format のデータ、またはその形式に変換できるデータがクリップボードに存在する場合は true。それ以外の場合は false。

例外

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

解説

DataFormats クラスには、このメソッドで使用できる定義済みの形式の名前が含まれています。

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

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

メモ

形式変換を有効にしてデータが格納されている場合、要求した形式が、格納されている形式と互換性があれば、そのデータを別の形式に変換できます。たとえば、Unicode として格納されたデータをテキストに変換できます。

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

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