Clipboard.GetText Método

Definição

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

Recupera dados de texto do Clipboard.

Sobrecargas

Name Description
GetText(TextDataFormat)

Recupera dados de texto do Clipboard no formato indicado pelo valor especificado TextDataFormat .
GetText()

Recupera dados de texto do Clipboard no Text formato ou, UnicodeText dependendo do sistema operativo.

GetText(TextDataFormat)

Origem:
Clipboard.cs
Origem:
Clipboard.cs
Origem:
Clipboard.cs
Origem:
Clipboard.cs
Origem:
Clipboard.cs

Recupera dados de texto do Clipboard no formato indicado pelo valor especificado TextDataFormat .

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 TextDataFormat valores.

Devoluções

String

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

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.

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

Use o ContainsText método para determinar se a Área de Transferência contém dados de texto antes de os recuperar com este método.

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

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

GetText()

Origem:
Clipboard.cs
Origem:
Clipboard.cs
Origem:
Clipboard.cs
Origem:
Clipboard.cs
Origem:
Clipboard.cs

Recupera dados de texto do Clipboard no Text formato ou, UnicodeText dependendo do sistema operativo.

public:
 static System::String ^ GetText();
public static string GetText();
static member GetText : unit -> string
Public Shared Function GetText () As String

Devoluções

String

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

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.

Exemplos

O exemplo seguinte demonstra uma sobrecarga do GetText 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 devolve dados de texto no formato UnicodeText no Windows XP Home Edition, Windows XP Professional, Windows Server 2003 e Windows 2000. Caso contrário, este método devolve 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 os recuperar com este método.

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

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