Procedimiento para recuperar datos del Portapapeles

La clase Clipboard proporciona métodos que se pueden usar para interactuar con la característica Portapapeles del sistema operativo Windows. Muchas aplicaciones usan el Portapapeles como repositorio temporal para los datos. Por ejemplo, los procesadores de texto usan el Portapapeles durante las operaciones de cortar y pegar. El Portapapeles también es útil para transferir información de una aplicación a otra.

Algunas aplicaciones almacenan datos en el Portapapeles en varios formatos para aumentar el número de aplicaciones que potencialmente pueden usar los datos. El formato de Portapapeles es una cadena que identifica el formato. Una aplicación que usa el formato identificado puede recuperar los datos asociados en el Portapapeles. La clase DataFormats proporciona nombres de formato predefinidos para su uso. También puede usar sus propios nombres de formato o usar un tipo de objeto como formato. Para obtener información sobre cómo agregar datos al Portapapeles, consulte Procedimiento para agregar datos al Portapapeles.

Para determinar si el Portapapeles contiene datos en un formato determinado, use uno de los métodos ContainsFormat o el método GetData. Para recuperar datos del Portapapeles, use uno de los métodos GetFormat o el método GetData. Estos métodos son nuevos en .NET Framework 2.0.

Para acceder a los datos del Portapapeles mediante versiones anteriores a .NET Framework 2.0, use el método Clipboard.GetDataObject y llame a los métodos del IDataObject devuelto. Para determinar si un formato determinado está disponible en el objeto devuelto, por ejemplo, llame al método GetDataPresent.

Para recuperar datos del Portapapeles en un único formato común

1. Use el método GetAudioStream, GetFileDropList, GetImage o GetText. Opcionalmente, use primero los métodos ContainsFormat correspondientes para determinar si los datos están disponibles en un formato determinado. Estos métodos solo están disponibles en .NET Framework 2.0.

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

   ' 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
   

Para recuperar datos del Portapapeles en un formato personalizado

1. Use el método GetData con un nombre de formato personalizado. Este método solo está disponible en .NET Framework 2.0.

   También puede usar nombres de formato predefinidos con el método SetData. Para obtener más información, vea DataFormats.

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

   ' 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 string nameValue = string.Empty;
       public Customer(String name)
       {
           nameValue = name;
       }
       public string Name
       {
           get { return nameValue; }
           set { nameValue = value; }
       }
   }
   

   <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
   

Para recuperar datos del Portapapeles en varios formatos

1. Use el método GetDataObject. Debe usar este método para recuperar datos del Portapapeles en versiones anteriores a .NET Framework 2.0.

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

   ' 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 string nameValue = string.Empty;
       public Customer(String name)
       {
           nameValue = name;
       }
       public string Name
       {
           get { return nameValue; }
           set { nameValue = value; }
       }
   }
   

   <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
   

Consulte también

• Compatibilidad con las operaciones de arrastrar y colocar y con el Portapapeles
• Procedimiento para agregar datos al Portapapeles