Clipboard.GetText Método

Definição

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Recupera dados de texto da Área de Transferência.

Sobrecargas

GetText()	Recupera dados de texto da Área de Transferência no formato Text ou UnicodeText, dependendo do sistema operacional.
GetText(TextDataFormat)	Recupera os dados de texto da Área de Transferência no formato indicado pelo valor TextDataFormat especificado.

GetText()

Recupera dados de texto da Área de Transferência no formato Text ou UnicodeText, dependendo do sistema operacional.

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

public static string GetText ();

static member GetText : unit -> string

Public Shared Function GetText () As String

Retornos

String

Os dados de texto da Área de Transferência ou Empty se a Área de Transferência não contiver dados no formato Text ou UnicodeText, dependendo do sistema operacional.

Exceções

ExternalException

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

ThreadStateException

O thread atual não está no modo STA (Single-Threaded Apartment). Adicione o STAThreadAttribute ao método Main do aplicativo.

Exemplos

O exemplo a seguir demonstra uma sobrecarga do GetText 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 retorna dados de texto no UnicodeText formato no Windows XP Home Edition, Windows XP Professional, Windows Server 2003 e Windows 2000. Caso contrário, esse método retornará dados de texto no Text formato .

Use o ContainsText método para determinar se a Área de Transferência contém dados de texto antes de recuperá-los com esse método.

Use o SetText método para adicionar dados de texto à Área de Transferência.

Observação

A Clipboard classe só pode ser usada em threads definidos como modo STA (single thread apartment). Para usar essa classe, verifique se o Main método está marcado com o STAThreadAttribute atributo .

Confira também

• TextDataFormat
• ContainsText
• SetText

GetText(TextDataFormat)

Recupera os dados de texto da Área de Transferência no formato indicado pelo valor TextDataFormat especificado.

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

Parâmetros

format

TextDataFormat

Um dos valores de TextDataFormat.

Retornos

String

Os dados de texto da Área de Transferência ou Empty se a Área de Transferência não contiver dados no formato especificado.

Exceções

ExternalException

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

ThreadStateException

O thread atual não está no modo STA (Single-Threaded Apartment). Adicione o STAThreadAttribute ao método Main do aplicativo.

InvalidEnumArgumentException

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

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

Use o ContainsText método para determinar se a Área de Transferência contém dados de texto antes de recuperá-los com esse método.

Use o SetText método para adicionar dados de texto à Área de Transferência.

Observação

A Clipboard classe só pode ser usada em threads definidos como modo STA (single thread apartment). Para usar essa classe, verifique se o Main método está marcado com o STAThreadAttribute atributo .

Confira também

• TextDataFormat
• ContainsText
• SetText