Clipboard.ContainsData(String) メソッド

  • リファレンス

定義

名前空間:
System.Windows.Forms
アセンブリ:
System.Windows.Forms.dll

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

public:
 static bool ContainsData(System::String ^ format);
public static bool ContainsData (string format);
public static bool ContainsData (string? format);
static member ContainsData : string -> bool
Public Shared Function ContainsData (format As String) As Boolean

パラメーター

format
String

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

戻り値

Boolean

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

例外

ExternalException

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

ThreadStateException

現在のスレッドがシングル スレッド アパートメント (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

注釈

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

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

Note

データは、その変換が許可されていることを指定して格納されている場合、および要求された形式が格納された形式と互換性がある場合は、別の形式に変換できます。 たとえば、Unicode として格納されているデータをテキストに変換できます。

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

適用対象

こちらもご覧ください