Clipboard.GetText Méthode

Définition

Espace de noms:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Récupère des données textuelles du Presse-papiers.

Surcharges

GetText()	Récupère des données textuelles du Presse-papiers dans le format Text ou UnicodeText, selon le système d'exploitation.
GetText(TextDataFormat)	Récupère des données textuelles du Presse-papiers dans le format indiqué par la valeur TextDataFormat spécifiée.

GetText()

Récupère des données textuelles du Presse-papiers dans le format Text ou UnicodeText, selon le système d'exploitation.

public:
 static System::String ^ GetText();

public static string GetText ();

static member GetText : unit -> string

Public Shared Function GetText () As String

Retours

String

Données textuelles du Presse-papiers ou Empty si le Presse-papiers ne contient pas de données au format Text ou UnicodeText, selon le système d'exploitation.

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 GetText 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 retourne 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 retourne des données de texte au Text format .

Utilisez la ContainsText méthode pour déterminer si le Presse-papiers contient des données texte avant de les récupérer avec cette méthode.

Utilisez la SetText méthode pour ajouter des données de texte au Presse-papiers.

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
• SetText

GetText(TextDataFormat)

Récupère des données textuelles du Presse-papiers dans le format indiqué par la valeur TextDataFormat spécifiée.

public:
 static System::String ^ GetText(System::Windows::Forms::TextDataFormat format);

public static string GetText (System.Windows.Forms.TextDataFormat format);

static member GetText : System.Windows.Forms.TextDataFormat -> string

Public Shared Function GetText (format As TextDataFormat) As String

Paramètres

format

TextDataFormat

Une des valeurs de l'objet TextDataFormat.

Retours

String

Données textuelles du Presse-papiers ou Empty si le Presse-papiers ne contient pas de données au format spécifié.

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

Utilisez la SetText méthode pour ajouter des données de texte au Presse-papiers.

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
• SetText