Clipboard.SetText Método

Definição

Namespace:
System.Windows.Forms
Assembly:
System.Windows.Forms.dll

Limpa a Área de Transferência e adiciona dados de texto a ela.

Sobrecargas

Nome Description
SetText(String)

Limpa a Área de Transferência e adiciona dados de texto no formato ou UnicodeText no Text formato, dependendo do sistema operacional.
SetText(String, TextDataFormat)

Limpa a Área de Transferência e adiciona dados de texto no formato indicado pelo valor especificado TextDataFormat .

SetText(String)

Limpa a Área de Transferência e adiciona dados de texto no formato ou UnicodeText no Text formato, dependendo do sistema operacional.

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)

Parâmetros

text
String

O texto a ser adicionado à Área de Transferência.

Exceções

ExternalException

Não foi possível limpar a área de transferência. Isso normalmente ocorre quando a Área de Transferência está sendo usada por outro processo.

ThreadStateException

O thread atual não está no modo STA (apartamento de thread único). Adicione o STAThreadAttribute método do Main aplicativo.

ArgumentNullException

text é null ou Empty.

Exemplos

O exemplo a seguir demonstra uma sobrecarga do SetText método semelhante a essa sobrecarga.

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

Comentários

Esse método adiciona dados de texto no formato UnicodeText no Windows XP Home Edition, Windows XP Professional, Windows Server 2003 e Windows 2000. Caso contrário, esse método adicionará dados de texto no Text formato.

Para recuperar dados de texto da Área de Transferência, primeiro use o ContainsText método para determinar se a Área de Transferência contém dados de texto antes de recuperá-los com o GetText método.

Note

A classe Clipboard só pode ser usada em threads configurados no modo STA (Single Thread Apartment). Para usar essa classe, verifique se o método Main está marcado com o atributo STAThreadAttribute.

Confira também

Aplica-se a

SetText(String, TextDataFormat)

Limpa a Área de Transferência e adiciona dados de texto no formato indicado pelo valor especificado TextDataFormat .

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)

Parâmetros

text
String

O texto a ser adicionado à Área de Transferência.

format
TextDataFormat

Um dos TextDataFormat valores.

Exceções

ExternalException

Não foi possível limpar a área de transferência. Isso normalmente ocorre quando a Área de Transferência está sendo usada por outro processo.

ThreadStateException

O thread atual não está no modo STA (apartamento de thread único). Adicione o STAThreadAttribute método do Main aplicativo.

ArgumentNullException

text é null ou Empty.

InvalidEnumArgumentException

format não é um valor válido TextDataFormat .

Exemplos

O exemplo a seguir demonstra esse membro.

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

Comentários

Para recuperar dados de texto da Área de Transferência, primeiro use o ContainsText método para determinar se a Área de Transferência contém dados de texto antes de recuperá-los com o GetText método.

Note

A classe Clipboard só pode ser usada em threads configurados no modo STA (Single Thread Apartment). Para usar essa classe, verifique se o método Main está marcado com o atributo STAThreadAttribute.

Confira também

Aplica-se a