Clipboard.SetText Méthode

Définition

Espace de noms:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Efface le Presse-papiers puis y ajoute des données de texte.

Surcharges

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.
SetText(String, TextDataFormat)	Efface le Presse-papiers puis ajoute des données de texte au format indiqué par la valeur TextDataFormat spécifiée.

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.

public:
 static void SetText(System::String ^ text);

public static void SetText (string text);

static member SetText : string -> unit

Public Shared Sub SetText (text As String)

Paramètres

text

String

Texte à ajouter au Presse-papiers.

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

text est null ou Empty.

Exemples

L’exemple suivant illustre une surcharge de la SetText méthode qui est 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 ajoute des données texte au UnicodeText format sur Windows XP Édition familiale, Windows XP Professionnel, Windows Server 2003 et Windows 2000. Sinon, cette méthode ajoute des données texte au Text format .

Pour récupérer des données de texte à partir du Presse-papiers, utilisez d’abord la ContainsText 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
• ContainsText
• GetText

SetText(String, TextDataFormat)

Efface le Presse-papiers puis ajoute des données de texte au format indiqué par la valeur TextDataFormat spécifiée.

public:
 static void SetText(System::String ^ text, System::Windows::Forms::TextDataFormat format);

public static void SetText (string text, System.Windows.Forms.TextDataFormat format);

static member SetText : string * System.Windows.Forms.TextDataFormat -> unit

Public Shared Sub SetText (text As String, format As TextDataFormat)

Paramètres

text

String

Texte à ajouter au Presse-papiers.

format

TextDataFormat

Une des valeurs de l'objet TextDataFormat.

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

text est null ou Empty.

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

Pour récupérer des données de texte à partir du Presse-papiers, utilisez d’abord la ContainsText 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
• ContainsText
• GetText