HOW TO：從剪貼簿擷取資料

Clipboard 類別提供了一些方法，可以用來與 Windows 作業系統的剪貼簿功能互動。 許多應用程式都將剪貼簿當做資料的暫時儲存機制。 例如，文書處理器在進行剪下和貼上作業時就會使用剪貼簿。 剪貼簿也非常適合用來將資料從一個應用程式傳送到另一個應用程式。

有些應用程式會將資料以多種格式儲存在剪貼簿上，以增加其他可能使用這些資料的應用程式數目。 剪貼簿檔案格式是一個用來辨識格式的字串。 使用所辨識之格式的應用程式可以從剪貼簿擷取相關聯的資料。 DataFormats 類別會提供預先定義的格式名稱，以供您使用。 您也可以使用自己的格式名稱，或將某個物件的型別當做其格式使用。 如需將資料加入至剪貼簿的詳細資訊，請參閱 HOW TO：將資料加入至剪貼簿。

若要判斷剪貼簿是否包含特定格式的資料，請使用其中一個 ContainsFormat 方法或 GetData 方法。 若要從剪貼簿擷取資料，則請使用其中一個 GetFormat 方法或 GetData 方法。 這些是 .NET Framework 2.0 版中的新方法。

若要使用 .NET Framework 2.0 之前的版本從剪貼簿擷取資料，請使用 GetDataObject 方法並呼叫所傳回之 IDataObject 的方法。 例如，若要判斷傳回的物件中是否包含特定格式，請呼叫 GetDataPresent 方法。

注意事項
所有 Windows 應用程式都會共用系統剪貼簿。 因此，剪貼簿的內容會根據您切換至不同的應用程式而改變。 Clipboard 類別只能用在設定為單一執行緒 Apartment (STA) 模式的執行緒中。 若要使用這個類別，請確定 Main 方法已使用 STAThreadAttribute 屬性加以標記。

若要以單一且通用的格式從剪貼簿擷取資料

• 請使用 GetAudioStream、GetFileDropList、GetImage 或 GetText 方法。 或者，請先使用對應的 ContainsFormat 方法來判斷資料是否為特定格式。 這些方法只能在 .NET Framework 2.0 版中取得。

  ' Demonstrates SetAudio, ContainsAudio, and GetAudioStream.
  Public Function SwapClipboardAudio( _
      ByVal replacementAudioStream As System.IO.Stream) _
      As System.IO.Stream
  
      Dim returnAudioStream As System.IO.Stream = Nothing
  
      If (Clipboard.ContainsAudio()) Then
          returnAudioStream = Clipboard.GetAudioStream()
          Clipboard.SetAudio(replacementAudioStream)
      End If
  
      Return returnAudioStream
  
  End Function
  
  ' Demonstrates SetFileDropList, ContainsFileDroList, and GetFileDropList
  Public Function SwapClipboardFileDropList(ByVal replacementList _
      As System.Collections.Specialized.StringCollection) _
      As System.Collections.Specialized.StringCollection
  
      Dim returnList As System.Collections.Specialized.StringCollection _
          = Nothing
  
      If Clipboard.ContainsFileDropList() Then
  
          returnList = Clipboard.GetFileDropList()
          Clipboard.SetFileDropList(replacementList)
      End If
  
      Return returnList
  
  End Function
  
  ' Demonstrates SetImage, ContainsImage, and GetImage.
  Public Function SwapClipboardImage( _
      ByVal replacementImage As System.Drawing.Image) _
      As System.Drawing.Image
  
      Dim returnImage As System.Drawing.Image = Nothing
  
      If Clipboard.ContainsImage() Then
          returnImage = Clipboard.GetImage()
          Clipboard.SetImage(replacementImage)
      End If
  
      Return returnImage
  End Function
  
  ' Demonstrates SetText, ContainsText, and GetText.
  Public Function SwapClipboardHtmlText( _
      ByVal replacementHtmlText As String) As String
  
      Dim returnHtmlText As String = Nothing
  
      If (Clipboard.ContainsText(TextDataFormat.Html)) Then
          returnHtmlText = Clipboard.GetText(TextDataFormat.Html)
          Clipboard.SetText(replacementHtmlText, TextDataFormat.Html)
      End If
  
      Return returnHtmlText
  
  End Function
  

  // Demonstrates SetAudio, ContainsAudio, and GetAudioStream.
  public System.IO.Stream SwapClipboardAudio(
      System.IO.Stream replacementAudioStream)
  {
      System.IO.Stream returnAudioStream = null;
      if (Clipboard.ContainsAudio())
      {
          returnAudioStream = Clipboard.GetAudioStream();
          Clipboard.SetAudio(replacementAudioStream);
      }
      return returnAudioStream;
  }
  
  // Demonstrates SetFileDropList, ContainsFileDroList, and GetFileDropList
  public System.Collections.Specialized.StringCollection
      SwapClipboardFileDropList(
      System.Collections.Specialized.StringCollection replacementList)
  {
      System.Collections.Specialized.StringCollection returnList = null;
      if (Clipboard.ContainsFileDropList())
      {
          returnList = Clipboard.GetFileDropList();
          Clipboard.SetFileDropList(replacementList);
      }
      return returnList;
  }
  
  // Demonstrates SetImage, ContainsImage, and GetImage.
  public System.Drawing.Image SwapClipboardImage(
      System.Drawing.Image replacementImage)
  {
      System.Drawing.Image returnImage = null;
      if (Clipboard.ContainsImage())
      {
          returnImage = Clipboard.GetImage();
          Clipboard.SetImage(replacementImage);
      }
      return returnImage;
  }
  
  // Demonstrates SetText, ContainsText, and GetText.
  public String SwapClipboardHtmlText(String replacementHtmlText)
  {
      String returnHtmlText = null;
      if (Clipboard.ContainsText(TextDataFormat.Html))
      {
          returnHtmlText = Clipboard.GetText(TextDataFormat.Html);
          Clipboard.SetText(replacementHtmlText, TextDataFormat.Html);
      }
      return returnHtmlText;
  }
  

若要以自訂的格式從剪貼簿擷取資料

• 請使用具有自訂格式名稱的 GetData 方法。 這個方法只能在 .NET Framework 2.0 版中取得。

  您也可以為 SetData 方法使用預先定義的格式名稱。 如需詳細資訊，請參閱 DataFormats。

  ' Demonstrates SetData, ContainsData, and GetData
  ' using a custom format name and a business object.
  Public ReadOnly Property TestCustomFormat() As Customer
      Get
          Clipboard.SetData("CustomerFormat", New Customer("Customer Name"))
  
          If Clipboard.ContainsData("CustomerFormat") Then
              Return CType(Clipboard.GetData("CustomerFormat"), Customer)
          End If
  
          Return Nothing
      End Get
  End Property
  
  
  ...
  
  
  <Serializable()> Public Class Customer
  
      Private nameValue As String = String.Empty
  
      Public Sub New(ByVal name As String)
          nameValue = name
      End Sub
  
      Public Property Name() As String
          Get
              Return nameValue
          End Get
          Set(ByVal value As String)
              nameValue = value
          End Set
      End Property
  
  End Class
  

  // Demonstrates SetData, ContainsData, and GetData
  // using a custom format name and a business object.
  public Customer TestCustomFormat
  {
      get
      {
          Clipboard.SetData("CustomerFormat", new Customer("Customer Name"));
          if (Clipboard.ContainsData("CustomerFormat")) 
          {
              return Clipboard.GetData("CustomerFormat") as Customer;
          }
          return null;
      }
  }
  
  
  ...
  
  
  [Serializable]
  public class Customer
  {
      private string nameValue = string.Empty;
      public Customer(String name)
      {
          nameValue = name;
      }
      public string Name
      {
          get { return nameValue; }
          set { nameValue = value; }
      }
  }
  

若要以多種格式從剪貼簿擷取資料

• 請使用 GetDataObject 方法。 您必須使用這個方法，才能從 .NET Framework 2.0 之前版本的剪貼簿擷取資料。

  ' Demonstrates how to use a DataObject to add
  ' data to the Clipboard in multiple formats.
  Public Sub TestClipboardMultipleFormats()
  
      Dim data As New DataObject()
  
      ' Add a Customer object using the type as the format.
      data.SetData(New Customer("Customer as Customer object"))
  
      ' Add a ListViewItem object using a custom format name.
      data.SetData("CustomFormat", _
          New ListViewItem("Customer as ListViewItem"))
  
      Clipboard.SetDataObject(data)
      Dim retrievedData As DataObject = _
          CType(Clipboard.GetDataObject(), DataObject)
  
      If (retrievedData.GetDataPresent("CustomFormat")) Then
  
          Dim item As ListViewItem = _
              TryCast(retrievedData.GetData("CustomFormat"), ListViewItem)
  
          If item IsNot Nothing Then
              MessageBox.Show(item.Text)
          End If
  
      End If
  
      If retrievedData.GetDataPresent(GetType(Customer)) Then
  
          Dim customer As Customer = _
              CType(retrievedData.GetData(GetType(Customer)), Customer)
  
          If customer IsNot Nothing Then
  
              MessageBox.Show(customer.Name)
          End If
  
      End If
  
  End Sub
  
  
  ...
  
  
  <Serializable()> Public Class Customer
  
      Private nameValue As String = String.Empty
  
      Public Sub New(ByVal name As String)
          nameValue = name
      End Sub
  
      Public Property Name() As String
          Get
              Return nameValue
          End Get
          Set(ByVal value As String)
              nameValue = value
          End Set
      End Property
  
  End Class
  

  // Demonstrates how to use a DataObject to add
  // data to the Clipboard in multiple formats.
  public void TestClipboardMultipleFormats()
  {
      DataObject data = new DataObject();
  
      // Add a Customer object using the type as the format.
      data.SetData(new Customer("Customer as Customer object"));
  
      // Add a ListViewItem object using a custom format name.
      data.SetData("CustomFormat", 
          new ListViewItem("Customer as ListViewItem"));
  
      Clipboard.SetDataObject(data);
      DataObject retrievedData = (DataObject)Clipboard.GetDataObject();
  
      if (retrievedData.GetDataPresent("CustomFormat"))
      {
          ListViewItem item = 
              retrievedData.GetData("CustomFormat") as ListViewItem;
          if (item != null)
          {
              MessageBox.Show(item.Text);
          }
      }
  
      if (retrievedData.GetDataPresent(typeof(Customer)))
      {
          Customer customer = 
              retrievedData.GetData(typeof(Customer)) as Customer;
          if (customer != null)
          {
              MessageBox.Show(customer.Name);
          }
      }
  }
  
  
  ...
  
  
  [Serializable]
  public class Customer
  {
      private string nameValue = string.Empty;
      public Customer(String name)
      {
          nameValue = name;
      }
      public string Name
      {
          get { return nameValue; }
          set { nameValue = value; }
      }
  }
  

請參閱

工作

HOW TO：將資料加入至剪貼簿

其他資源

拖放作業和剪貼簿支援