Clipboard.SetText Método

Definição

Espaço de Nomes:
System.Windows.Forms
Assemblagem:
System.Windows.Forms.dll

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

Sobrecargas

Name Description
SetText(String)

Limpa a área de transferência e depois adiciona dados de texto no Text formato ou, UnicodeText dependendo do sistema operativo.
SetText(String, TextDataFormat)

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

SetText(String)

Limpa a área de transferência e depois adiciona dados de texto no Text formato ou, UnicodeText dependendo do sistema operativo.

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 para adicionar à Prancheta.

Exceções

ExternalException

A prancheta não pôde ser limpa. Isto ocorre tipicamente quando a Prancheta está a ser usada por outro processo.

ThreadStateException

O tópico atual não está em modo apartamento single-threaded (STA). Adicione-os STAThreadAttribute ao processo da Main sua candidatura.

ArgumentNullException

text é null ou Empty.

Exemplos

O exemplo seguinte demonstra uma sobrecarga do SetText método semelhante a esta 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

Observações

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

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

Note

A classe Clipboard só pode ser usada em threads configurados para o modo apartamento de thread único (modo STA). Para usar essa classe, verifique se o método Main está marcado com o atributo STAThreadAttribute.

Ver também

Aplica-se a

SetText(String, TextDataFormat)

Limpa a Área de Transferência e depois 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 para adicionar à Prancheta.

format
TextDataFormat

Um dos TextDataFormat valores.

Exceções

ExternalException

A prancheta não pôde ser limpa. Isto ocorre tipicamente quando a Prancheta está a ser usada por outro processo.

ThreadStateException

O tópico atual não está em modo apartamento single-threaded (STA). Adicione-os STAThreadAttribute ao processo da Main sua candidatura.

ArgumentNullException

text é null ou Empty.

InvalidEnumArgumentException

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

Exemplos

O exemplo seguinte demonstra este elemento.

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

Observações

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

Note

A classe Clipboard só pode ser usada em threads configurados para o modo apartamento de thread único (modo STA). Para usar essa classe, verifique se o método Main está marcado com o atributo STAThreadAttribute.

Ver também

Aplica-se a