Clipboard.GetData(String) Méthode

  • Référence

Définition

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

Récupère des données du Presse-papiers dans le format spécifié.

public:
 static System::Object ^ GetData(System::String ^ format);
public static object GetData (string format);
public static object? GetData (string format);
static member GetData : string -> obj
Public Shared Function GetData (format As String) As Object

Paramètres

format
String

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

Retours

Object

Object représentant les données du Presse-papiers ou null si le Presse-papiers ne contient pas de données au format spécifié ou qui peuvent être converties dans ce format.

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.

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

Utilisez la ContainsData méthode pour déterminer si le Presse-papiers contient des données dans le format spécifié ou un format compatible avant de le récupérer avec cette méthode.

Si cette méthode ne trouve pas de données dans le format spécifié, elle tente de convertir les données au format. Si les données ne peuvent pas être converties au format spécifié ou si les données ont été stockées avec la conversion automatique définie falsesur , cette méthode retourne null.

Notes

Les données peuvent être converties dans un autre format s’il a été stocké en spécifiant que la conversion est autorisée et si le format demandé est compatible avec le format stocké. Par exemple, les données stockées en Unicode peuvent être converties en texte.

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 .

Utilisez la SetData méthode pour ajouter des données au Presse-papiers dans un format particulier.

S’applique à

Voir aussi