Clipboard クラスとは何？わかりやすく解説 Weblio辞書

メモ
データを複数の形式でクリップボードに貼り付けておくと、データを取り出す側のアプリケーションで使用できるデータ形式がわからなくても、データを正常に取得できます。

クリップボードからデータを取得するには、GetDataObject を呼び出します。取得対象のデータは、IDataObject インターフェイスを実装したオブジェクトとして返されます。IDataObject で指定されているメソッドと、DataFormats のフィールドを使用して、返されたオブジェクトからデータを抽出します。取得したデータの形式が不明な場合は、IDataObject インターフェイスの GetFormats メソッドを呼び出し、データの格納形式すべてのリストを取得します。次に IDataObject インターフェイスの GetData メソッドを呼び出し、取り出す側のアプリケーションで使用できる形式を指定します。

Microsoft .NET Framework version 2.0 では、Clipboard クラスに、システムクリップボードを簡単に処理できるようにする追加メソッドが用意されています。クリップボードからすべてのデータを削除するには、Clear メソッドを呼び出します。特定の形式のデータをクリップボードに追加するには、SetText などの適切な SetFormat メソッドを呼び出すか、SetData メソッドを呼び出してその形式を指定します。クリップボードから特定の形式のデータを取得するには、まず適切な ContainsFormat メソッド (ContainsText など) を呼び出してクリップボードにその形式のデータが含まれているかどうかを確認します。クリップボードにそのデータが含まれている場合は、次に適切な GetFormat メソッド (GetText など) を呼び出してデータを取得します。これらの操作の際に形式を指定するには、代わりに、ContainsData メソッドおよび GetData メソッドを呼び出します。

メモ
システムクリップボードはすべての Windows ベースのアプリケーションで共有されるため、その内容は、他のアプリケーションに切り替えた場合に変更されることがあります。クリップボードに格納するには、オブジェクトはシリアル化可能である必要があります。シリアル化可能でないオブジェクトをクリップボードのメソッドに渡すと、メソッドは例外をスローせずに失敗します。シリアル化の詳細については、「シリアル化」を参照してください。対象のアプリケーションが、非常に限定されたデータ形式を必要とする場合は、シリアル化プロセスでデータにヘッダーを追加すると、アプリケーションがデータを認識できない場合があります。データ形式を維持するには、データを Byte 配列として MemoryStream に追加し、その MemoryStream を SetData メソッドに渡します。 Clipboard クラスは、シングルスレッドアパートメント (STA: Single Thread Apartment) モードに設定されているスレッドでだけ使用できます。このクラスを使用するには、Main メソッドが確実に STAThreadAttribute 属性でマークされているようにします。クリップボードでメタファイル形式を使用する場合には、特別な配慮が必要な場合があります。DataObject クラスの現在の実装における制限により、.NET Framework で使用されるメタファイル形式は、旧メタファイル形式を使用するアプリケーションでは認識されない場合があります。この場合は、Win32 クリップボードアプリケーションプログラミングインターフェイス (API: Application Programming Interface) で相互運用する必要があります。詳細については、http://support.microsoft.com にある Microsoft サポート技術情報の文書 323530 (「Metafiles on Clipboard Are Not Visible to All Applications」) を参照してください。

メモ

システムクリップボードはすべての Windows ベースのアプリケーションで共有されるため、その内容は、他のアプリケーションに切り替えた場合に変更されることがあります。

クリップボードに格納するには、オブジェクトはシリアル化可能である必要があります。シリアル化可能でないオブジェクトをクリップボードのメソッドに渡すと、メソッドは例外をスローせずに失敗します。シリアル化の詳細については、「シリアル化」を参照してください。対象のアプリケーションが、非常に限定されたデータ形式を必要とする場合は、シリアル化プロセスでデータにヘッダーを追加すると、アプリケーションがデータを認識できない場合があります。データ形式を維持するには、データを Byte 配列として MemoryStream に追加し、その MemoryStream を SetData メソッドに渡します。

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

クリップボードでメタファイル形式を使用する場合には、特別な配慮が必要な場合があります。DataObject クラスの現在の実装における制限により、.NET Framework で使用されるメタファイル形式は、旧メタファイル形式を使用するアプリケーションでは認識されない場合があります。この場合は、Win32 クリップボードアプリケーションプログラミングインターフェイス (API: Application Programming Interface) で相互運用する必要があります。詳細については、http://support.microsoft.com にある Microsoft サポート技術情報の文書 323530 (「Metafiles on Clipboard Are Not Visible to All Applications」) を参照してください。

Windows Mobile for Pocket PC、Windows Mobile for Smartphone、Windows CE プラットフォームメモ : Windows CE では、クリップボードから貼り付けられたメモリストリームは、クリップボードにコピーされたメモリストリームよりもわずかに大きなサイズを保持できます。元のメモリストリームの最後に追加のバイトを付加できるからです。メモリストリームを厳密に受け取るには、オブジェクトがメモリストリームを受け取る方法を判断するためのサイズをプレフィックスとしてオブジェクトに追加するか、メモリストリームとそのサイズの文字列値を含む DataObject をクリップボードにコピーします。

使用例

Clipboard のメソッドを使用して、システムクリップボードにデータを貼り付けたり、システムクリップボードからデータを取得したりするコード例を次に示します。このコードは、button1、button2、textBox1、および textBox2 が既に作成され、フォームに配置されていることを前提にしています。

button1_Click メソッドは、SetDataObject を呼び出して、テキストボックス内で選択されているテキストを取り出し、システムクリップボードに貼り付けます。

button2_Click メソッドは、GetDataObject を呼び出して、システムクリップボードからデータを取得します。コードは IDataObject と DataFormats を使用して、返されたデータを抽出して textBox2 に表示します。

Visual Basic

Private Sub button1_Click(sender As
 Object, e As System.EventArgs)
    ' Takes the selected text from a text box and puts it on the clipboard.
    If textBox1.SelectedText <> ""
 Then
        Clipboard.SetDataObject(textBox1.SelectedText)
    Else
        textBox2.Text = "No text selected in textBox1"
    End If
End Sub 'button1_Click
 
Private Sub button2_Click(sender As
 Object, e As System.EventArgs)
    ' Declares an IDataObject to hold the data returned from the clipboard.
    ' Retrieves the data from the clipboard.
    Dim iData As IDataObject = Clipboard.GetDataObject()
    
    ' Determines whether the data is in a format you can use.
    If iData.GetDataPresent(DataFormats.Text) Then
        ' Yes it is, so display it in a text box.
        textBox2.Text = CType(iData.GetData(DataFormats.Text), String)
    Else
        ' No it is not.
        textBox2.Text = "Could not retrieve data off the clipboard."
    End If
End Sub 'button2_Click

private void button1_Click(object sender, System.EventArgs
 e) {
    // Takes the selected text from a text box and puts it on the clipboard.
    if(textBox1.SelectedText != "")
       Clipboard.SetDataObject(textBox1.SelectedText);
    else
       textBox2.Text = "No text selected in textBox1";
 }
 
 private void button2_Click(object sender,
 System.EventArgs e) {
    // Declares an IDataObject to hold the data returned from the clipboard.
    // Retrieves the data from the clipboard.
    IDataObject iData = Clipboard.GetDataObject();
 
    // Determines whether the data is in a format you can use.
    if(iData.GetDataPresent(DataFormats.Text)) {
       // Yes it is, so display it in a text box.
       textBox2.Text = (String)iData.GetData(DataFormats.Text); 
    }
    else {
       // No it is not.
       textBox2.Text = "Could not retrieve data off the clipboard.";
    }
 }

C++

private:
   void button1_Click( Object^ /*sender*/, System::EventArgs^
 /*e*/ )
   {
      // Takes the selected text from a text box and puts it on the
 clipboard.
      if ( !textBox1->SelectedText->Equals( ""
 ) )
      {
         Clipboard::SetDataObject( textBox1->SelectedText );
      }
      else
      {
         textBox2->Text = "No text selected in textBox1";
      }
   }

   void button2_Click( Object^ /*sender*/, System::EventArgs^
 /*e*/ )
   {
      // Declares an IDataObject to hold the data returned from the
 clipboard.
      // Retrieves the data from the clipboard.
      IDataObject^ iData = Clipboard::GetDataObject();
      
      // Determines whether the data is in a format you can use.
      if ( iData->GetDataPresent( DataFormats::Text ) )
      {
         // Yes it is, so display it in a text box.
         textBox2->Text = (String^)(iData->GetData( DataFormats::Text ));
      }
      else
      {
         // No it is not.
         textBox2->Text = "Could not retrieve data off the clipboard.";
      }
   }

private void button1_Click(Object sender, System.EventArgs
 e)
{
    // Takes the selected text from a text box and puts it on the clipboard.
    if (!textBox1.get_SelectedText().Equals("")) {
        Clipboard.SetDataObject(textBox1.get_SelectedText());
    }
    else {
        textBox2.set_Text("No text selected in textBox1");
    }
} //button1_Click

private void button2_Click(Object sender, System.EventArgs
 e)
{
    // Declares an IDataObject to hold the data returned from the clipboard.
    // Retrieves the data from the clipboard.
    IDataObject iData = Clipboard.GetDataObject();

    // Determines whether the data is in a format you can use.
    if (iData.GetDataPresent(DataFormats.Text)) {
        // Yes it is, so display it in a text box.
        textBox2.set_Text((String)(iData.GetData(DataFormats.Text)));
    }
    else {
        // No it is not.
        textBox2.set_Text("Could not retrieve data off the clipboard.");
    }
} //button2_Click

JScript

private function button1_Click(sender : Object,
 e : System.EventArgs) {
    //Take the selected text from a text box and put it on the clipboard.
    if(textBox1.SelectedText != "")
       Clipboard.SetDataObject(textBox1.SelectedText);
    else
       textBox2.Text = "No text selected in textBox1";
 }
 
 private function button2_Click(sender : Object,
 e : System.EventArgs) {
    //Declare an IDataObject to hold the data returned from the clipboard.
    //Then retrieve the data from the clipboard.
    var iData : IDataObject = Clipboard.GetDataObject();
 
    //Determine whether the data is in a format you can use.
    if(iData.GetDataPresent(DataFormats.Text)) {
       //Yes it is, so display it in a text box.
       textBox2.Text = String(iData.GetData(DataFormats.Text)); 
    }
    else {
       //No it is not.
       textBox2.Text = "Could not retrieve data off the clipboard.";
    }
 }