Clipboard.ContainsText Méthode

Définition

Espace de noms:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Indique si le Presse-papiers contient des données textuelles.

Surcharges

ContainsText()	Indique si le Presse-papiers contient des données au format Text ou UnicodeText, selon le système d'exploitation.
ContainsText(TextDataFormat)	Indique si le Presse-papiers contient des données textuelles au format indiqué par la valeur TextDataFormat spécifiée.

ContainsText()

Indique si le Presse-papiers contient des données au format Text ou UnicodeText, selon le système d'exploitation.

public:
 static bool ContainsText();

public static bool ContainsText ();

static member ContainsText : unit -> bool

Public Shared Function ContainsText () As Boolean

Retours

Boolean

true si le Presse-papiers contient des données textuelles ; sinon, false.

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 une surcharge de la ContainsText méthode similaire à cette surcharge.

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

Remarques

Cette méthode vérifie la présence de données au UnicodeText format sur Windows XP Home Edition, Windows XP Professional, Windows Server 2003 et Windows 2000. Sinon, cette méthode vérifie la présence de données au Text format.

Utilisez cette méthode pour déterminer si le Presse-papiers contient des données de texte avant de les récupérer avec la GetText 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 .

Voir aussi

• TextDataFormat
• Text
• UnicodeText
• GetText
• SetText

ContainsText(TextDataFormat)

Indique si le Presse-papiers contient des données textuelles au format indiqué par la valeur TextDataFormat spécifiée.

public:
 static bool ContainsText(System::Windows::Forms::TextDataFormat format);

public static bool ContainsText (System.Windows.Forms.TextDataFormat format);

static member ContainsText : System.Windows.Forms.TextDataFormat -> bool

Public Shared Function ContainsText (format As TextDataFormat) As Boolean

Paramètres

format

TextDataFormat

Une des valeurs de l'objet TextDataFormat.

Retours

Boolean

true si le Presse-papiers contient des données textuelles dans la valeur spécifiée pour format ; sinon, false.

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.

InvalidEnumArgumentException

format n’est pas une valeur de TextDataFormat valide.

Exemples

L’exemple suivant illustre ce membre.

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

Remarques

Utilisez cette méthode pour déterminer si le Presse-papiers contient des données texte avant de les récupérer avec la GetText 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 .

Voir aussi

• TextDataFormat
• GetText
• SetText