Clipboard.SetData(String, Object) Méthode

  • Référence

Définition

Espace de noms:
System.Windows.Forms
Assembly:
System.Windows.Forms.dll

Efface le Presse-papiers puis ajoute des données au format spécifié.

public:
 static void SetData(System::String ^ format, System::Object ^ data);
public static void SetData (string format, object data);
static member SetData : string * obj -> unit
Public Shared Sub SetData (format As String, data As Object)

Paramètres

format
String

Format des données à définir. Consultez DataFormats pour obtenir les formats prédéfinis.

data
Object

Object représentant les données à ajouter.

Exceptions

ExternalException

Le Presse-papiers n'a pas pu être effacé. Cela se produit en général lorsque le Presse-papiers est utilisé par un autre processus.

ThreadStateException

Le thread actuel n'est pas en mode thread cloisonné (STA, Single-Threaded Apartment). Ajoutez STAThreadAttribute à la méthode Main de votre application.

ArgumentNullException

data a la valeur null.

Exemples

L’exemple suivant illustre ce membre.

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

Remarques

Si vous ne connaissez pas le format de l’application cible, vous pouvez stocker des données dans plusieurs formats à l’aide de cette méthode.

Les données stockées à l’aide de cette méthode peuvent être converties dans un format compatible lorsqu’elles sont récupérées.

Pour récupérer des données du Presse-papiers dans un format particulier, utilisez d’abord la ContainsData méthode pour déterminer si le Presse-papiers contient des données dans ce format avant de les récupérer avec la GetData méthode .

Notes

La Clipboard classe ne peut être utilisée que dans les threads définis en mode STA (Single Thread Apartment). Pour utiliser cette classe, vérifiez que votre Main méthode est marquée avec l’attribut STAThreadAttribute .

S’applique à

Voir aussi