Clipboard Clipboard Clipboard Clipboard Class

Définition

Fournit les méthodes permettant de placer des données dans le Presse-papiers système et d'en récupérer.Provides methods to place data on and retrieve data from the system Clipboard. Cette classe ne peut pas être héritée.This class cannot be inherited.

public ref class Clipboard sealed
public sealed class Clipboard
type Clipboard = class
Public NotInheritable Class Clipboard
Héritage
ClipboardClipboardClipboardClipboard

Exemples

L’exemple de code suivant Clipboard utilise des méthodes pour placer des données dans le presse-papiers du système et les récupérer.The following code example uses Clipboard methods to place data on and retrieve it from the system Clipboard. Ce code suppose que button1 button2 textBox1,, et textBox2 ont été créés et placés dans le formulaire.This code assumes button1, button2, textBox1, and textBox2 have been created and placed on the form.

La button1_Click méthode appelle SetDataObject pour prendre le texte sélectionné dans la zone de texte et le placer dans le presse-papiers du système.The button1_Click method calls SetDataObject to take selected text from the text box and place it on the system Clipboard.

La button2_Click méthode appelle GetDataObject pour récupérer des données du presse-papiers du système.The button2_Click method calls GetDataObject to retrieve data from the system Clipboard. Le code utilise IDataObject et DataFormats pour extraire les données retournées et affiche les textBox2données dans.The code uses IDataObject and DataFormats to extract the data returned and displays the data in textBox2.

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.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.";
    }
 }
 
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
 
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

Remarques

Pour obtenir la liste des formats prédéfinis à utiliser avec Clipboard la classe, consultez DataFormats la classe.For a list of predefined formats to use with the Clipboard class, see the DataFormats class.

Appelez SetDataObject pour placer des données dans le presse-papiers, en remplaçant son contenu actuel.Call SetDataObject to put data on the Clipboard, replacing its current contents. Pour placer une copie persistante des données dans le presse-papiers, copy affectez trueau paramètre la valeur.To place a persistent copy of the data on the Clipboard, set the copy parameter to true.

Notes

Pour placer des données dans le presse-papiers dans plusieurs formats DataObject , utilisez la IDataObject classe ou une implémentation.To place data on the Clipboard in multiple formats, use the DataObject class or an IDataObject implementation. Placez les données dans le presse-papiers dans plusieurs formats pour optimiser la possibilité qu’une application cible, dont vous ne connaissez pas les exigences de format, puisse récupérer correctement les données.Place data on the Clipboard in multiple formats to maximize the possibility that a target application, whose format requirements you might not know, can successfully retrieve the data.

Appelez GetDataObject pour récupérer des données du presse-papiers.Call GetDataObject to retrieve data from the Clipboard. Les données sont retournées sous la forme d’un IDataObject objet qui implémente l’interface.The data is returned as an object that implements the IDataObject interface. Utilisez les méthodes spécifiées IDataObject par les champs DataFormats et dans pour extraire les données de l’objet.Use the methods specified by IDataObject and fields in DataFormats to extract the data from the object. Si vous ne connaissez pas le format des données que vous avez récupérées, GetFormats appelez la méthode IDataObject de l’interface pour obtenir la liste de tous les formats dans lesquels les données sont stockées.If you do not know the format of the data you retrieved, call the GetFormats method of the IDataObject interface to get a list of all formats that data is stored in. Appelez ensuite la GetData méthode de l' IDataObject interface et spécifiez un format que votre application peut utiliser.Then call the GetData method of the IDataObject interface, and specify a format that your application can use.

Dans .NET Framework 2.0.NET Framework 2.0, la Clipboard classe fournit des méthodes supplémentaires qui facilitent l’utilisation du presse-papiers du système.In .NET Framework 2.0.NET Framework 2.0, the Clipboard class provides additional methods that make it easier to work with the system Clipboard. Appelez la Clear méthode pour supprimer toutes les données du presse-papiers.Call the Clear method to remove all data from the Clipboard. Pour ajouter des données d’un format particulier au Presse-papiers, en remplaçant les données existantes, Setappelez la méthode de mise en forme appropriée, SetData telle que SetText, ou appelez la méthode pour spécifier le format.To add data of a particular format to the Clipboard, replacing the existing data, call the appropriate SetFormat method, such as SetText, or call the SetData method to specify the format. Pour récupérer les données d’un format particulier à partir du presse-papiers, Containsappelez d’abord la méthode ContainsTextde mise en forme appropriée (telle que) pour déterminer si le presse-papiers contient des données dans ce format, puis appelez le GetMéthode de mise en forme GetText(telle que) pour récupérer les données si le presse-papiers le contient.To retrieve data of a particular format from the Clipboard, first call the appropriate ContainsFormat method (such as ContainsText) method to determine whether the Clipboard contains data in that format, and then call the appropriate GetFormat method (such as GetText) to retrieve the data if the Clipboard contains it. Pour spécifier le format dans ces opérations, appelez plutôt ContainsData les GetData méthodes et.To specify the format in these operations, call the ContainsData and GetData methods instead.

Notes

Toutes les applications Windows partagent le presse-papiers du système, de sorte que le contenu est susceptible d’être modifié lorsque vous basculez vers une autre application.All Windows-based applications share the system Clipboard, so the contents are subject to change when you switch to another application.

Un objet doit être sérialisable pour être placé dans le presse-papiers.An object must be serializable for it to be put on the Clipboard. Si vous transmettez un objet non sérialisable à une méthode de presse-papiers, la méthode échoue sans lever d’exception.If you pass a non-serializable object to a Clipboard method, the method will fail without throwing an exception. Pour System.Runtime.Serialization plus d’informations sur la sérialisation, consultez.See System.Runtime.Serialization for more information on serialization. Si votre application cible requiert un format de données très spécifique, les en-têtes ajoutés aux données dans le processus de sérialisation peuvent empêcher l’application de reconnaître vos données.If your target application requires a very specific data format, the headers added to the data in the serialization process may prevent the application from recognizing your data. Pour conserver votre format de données, ajoutez vos données sous Byte forme de tableau MemoryStream à un et MemoryStream transmettez SetData le à la méthode.To preserve your data format, add your data as a Byte array to a MemoryStream and pass the MemoryStream to the SetData method.

La Clipboard classe ne peut être utilisée que dans les threads définis en mode STA (single thread Apartment).The Clipboard class can only be used in threads set to single thread apartment (STA) mode. Pour utiliser cette classe, assurez- Main vous que votre méthode est STAThreadAttribute marquée avec l’attribut.To use this class, ensure that your Main method is marked with the STAThreadAttribute attribute.

Des considérations spéciales peuvent être nécessaires lors de l’utilisation du format de métafichier avec le presse-papiers.Special considerations may be necessary when using the metafile format with the Clipboard. En raison d’une limitation de l’implémentation actuelle de DataObject la classe, le format de métafichier utilisé par le .NET Framework peut ne pas être reconnu par les applications qui utilisent un format de métafichier plus ancien.Due to a limitation in the current implementation of the DataObject class, the metafile format used by the .NET Framework may not be recognized by applications that use an older metafile format. Dans ce cas, vous devez interagir avec les interfaces de programmation d’application (API) du presse-papiers Win32.In this case, you must interoperate with the Win32 Clipboard application programming interfaces (APIs).

Méthodes

Clear() Clear() Clear() Clear()

Supprime toutes les données du Presse-papiers.Removes all data from the Clipboard.

ContainsAudio() ContainsAudio() ContainsAudio() ContainsAudio()

Indique si le Presse-papiers contient des données au format WaveAudio.Indicates whether there is data on the Clipboard in the WaveAudio format.

ContainsData(String) ContainsData(String) ContainsData(String) ContainsData(String)

Indique si le Presse-papiers contient des données au format spécifié ou qui peuvent être converties dans ce format.Indicates whether there is data on the Clipboard that is in the specified format or can be converted to that format.

ContainsFileDropList() ContainsFileDropList() ContainsFileDropList() ContainsFileDropList()

Indique si le Presse-papiers contient des données au format FileDrop ou qui peuvent être converties dans ce format.Indicates whether there is data on the Clipboard that is in the FileDrop format or can be converted to that format.

ContainsImage() ContainsImage() ContainsImage() ContainsImage()

Indique si le Presse-papiers contient des données au format Bitmap ou qui peuvent être converties dans ce format.Indicates whether there is data on the Clipboard that is in the Bitmap format or can be converted to that format.

ContainsText() ContainsText() ContainsText() ContainsText()

Indique si le Presse-papiers contient des données au format Text ou UnicodeText, selon le système d'exploitation.Indicates whether there is data on the Clipboard in the Text or UnicodeText format, depending on the operating system.

ContainsText(TextDataFormat) ContainsText(TextDataFormat) ContainsText(TextDataFormat) ContainsText(TextDataFormat)

Indique si le Presse-papiers contient des données textuelles au format indiqué par la valeur TextDataFormat spécifiée.Indicates whether there is text data on the Clipboard in the format indicated by the specified TextDataFormat value.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Détermine si l'objet spécifié est identique à l'objet actuel.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetAudioStream() GetAudioStream() GetAudioStream() GetAudioStream()

Récupère un flux audio dans le Presse-papiers.Retrieves an audio stream from the Clipboard.

GetData(String) GetData(String) GetData(String) GetData(String)

Récupère des données du Presse-papiers dans le format spécifié.Retrieves data from the Clipboard in the specified format.

GetDataObject() GetDataObject() GetDataObject() GetDataObject()

Récupère les données figurant dans le Presse-papiers système.Retrieves the data that is currently on the system Clipboard.

GetFileDropList() GetFileDropList() GetFileDropList() GetFileDropList()

Récupère une collection de noms de fichiers du Presse-papiers.Retrieves a collection of file names from the Clipboard.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Fait office de fonction de hachage par défaut.Serves as the default hash function.

(Inherited from Object)
GetImage() GetImage() GetImage() GetImage()

Récupère une image du Presse-papiers.Retrieves an image from the Clipboard.

GetText() GetText() GetText() GetText()

Récupère des données textuelles du Presse-papiers dans le format Text ou UnicodeText, selon le système d'exploitation.Retrieves text data from the Clipboard in the Text or UnicodeText format, depending on the operating system.

GetText(TextDataFormat) GetText(TextDataFormat) GetText(TextDataFormat) GetText(TextDataFormat)

Récupère des données textuelles du Presse-papiers dans le format indiqué par la valeur TextDataFormat spécifiée.Retrieves text data from the Clipboard in the format indicated by the specified TextDataFormat value.

GetType() GetType() GetType() GetType()

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crée une copie superficielle de l'objet Object actuel.Creates a shallow copy of the current Object.

(Inherited from Object)
SetAudio(Byte[]) SetAudio(Byte[]) SetAudio(Byte[]) SetAudio(Byte[])

Efface le Presse-papiers puis ajoute un tableau Byte au format WaveAudio après l'avoir converti en Stream.Clears the Clipboard and then adds a Byte array in the WaveAudio format after converting it to a Stream.

SetAudio(Stream) SetAudio(Stream) SetAudio(Stream) SetAudio(Stream)

Efface le Presse-papiers puis ajoute un Stream au format WaveAudio.Clears the Clipboard and then adds a Stream in the WaveAudio format.

SetData(String, Object) SetData(String, Object) SetData(String, Object) SetData(String, Object)

Efface le Presse-papiers puis ajoute des données au format spécifié.Clears the Clipboard and then adds data in the specified format.

SetDataObject(Object) SetDataObject(Object) SetDataObject(Object) SetDataObject(Object)

Efface le Presse-papiers puis y place des données non persistantes.Clears the Clipboard and then places nonpersistent data on it.

SetDataObject(Object, Boolean) SetDataObject(Object, Boolean) SetDataObject(Object, Boolean) SetDataObject(Object, Boolean)

Efface le Presse-papiers puis y place des données et spécifie si les données doivent rester lorsque l'application se ferme.Clears the Clipboard and then places data on it and specifies whether the data should remain after the application exits.

SetDataObject(Object, Boolean, Int32, Int32) SetDataObject(Object, Boolean, Int32, Int32) SetDataObject(Object, Boolean, Int32, Int32) SetDataObject(Object, Boolean, Int32, Int32)

Efface le Presse-papiers puis tente d'y placer des données le nombre spécifié de fois et dans le délai spécifié entre les tentatives, en laissant éventuellement les données dans le Presse-papiers lorsque l'utilisateur quitte l'application.Clears the Clipboard and then attempts to place data on it the specified number of times and with the specified delay between attempts, optionally leaving the data on the Clipboard after the application exits.

SetFileDropList(StringCollection) SetFileDropList(StringCollection) SetFileDropList(StringCollection) SetFileDropList(StringCollection)

Efface le Presse-papiers puis ajoute une collection de noms de fichier au format FileDrop.Clears the Clipboard and then adds a collection of file names in the FileDrop format.

SetImage(Image) SetImage(Image) SetImage(Image) SetImage(Image)

Efface le Presse-papiers puis ajoute un Image au format Bitmap.Clears the Clipboard and then adds an Image in the Bitmap format.

SetText(String) SetText(String) SetText(String) SetText(String)

Efface le Presse-papiers puis y ajoute des données de texte au format Text ou UnicodeText, selon le système d'exploitation.Clears the Clipboard and then adds text data in the Text or UnicodeText format, depending on the operating system.

SetText(String, TextDataFormat) SetText(String, TextDataFormat) SetText(String, TextDataFormat) SetText(String, TextDataFormat)

Efface le Presse-papiers puis ajoute des données de texte au format indiqué par la valeur TextDataFormat spécifiée.Clears the Clipboard and then adds text data in the format indicated by the specified TextDataFormat value.

ToString() ToString() ToString() ToString()

Retourne une chaîne qui représente l'objet actuel.Returns a string that represents the current object.

(Inherited from Object)

S’applique à

Voir aussi