Clipboard.GetText 方法

定义

命名空间:

System.Windows.Forms

程序集:

System.Windows.Forms.dll

从剪贴板中检索文本数据。

重载

GetText()	从剪贴板中检索 Text 或 UnicodeText 格式的文本数据（取决于操作系统）。
GetText(TextDataFormat)	从剪贴板中检索由指定的 TextDataFormat 值表示的格式的文本数据。

GetText()

从剪贴板中检索 Text 或 UnicodeText 格式的文本数据（取决于操作系统）。

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

public static string GetText ();

static member GetText : unit -> string

Public Shared Function GetText () As String

返回

String

剪贴板文本数据；如果剪贴板中不包含 Empty 或 Text 格式的数据（取决于操作系统），则为 UnicodeText。

例外

ExternalException

未能清空剪贴板。 这种情况通常发生在剪贴板正在被其他进程使用的时候。

ThreadStateException

当前线程未处于单线程单元 (STA) 模式下。 请将 STAThreadAttribute 添加到应用程序的 Main 方法中。

示例

下面的示例演示方法的 GetText 重载，该重载类似于此重载。

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

注解

此方法在 UnicodeText Windows XP Home Edition、Windows XP Professional、Windows Server 2003 和 Windows 2000 上返回格式的文本数据。 否则，此方法以 格式返回文本数据 Text 。

ContainsText在使用此方法检索剪贴板之前，请使用 方法确定剪贴板是否包含文本数据。

SetText使用 方法将文本数据添加到剪贴板。

注意

Clipboard 类只能在设置为单线程单元 (STA) 模式的线程中使用。 若要使用此类，请确保使用 Main 特性标记 STAThreadAttribute 方法。

另请参阅

• TextDataFormat
• ContainsText
• SetText

GetText(TextDataFormat)

从剪贴板中检索由指定的 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

参数

format

TextDataFormat

TextDataFormat 值之一。

返回

String

剪贴板文本数据；如果剪贴板中不包含指定格式的数据，则为 Empty。

例外

ExternalException

未能清空剪贴板。 这种情况通常发生在剪贴板正在被其他进程使用的时候。

ThreadStateException

当前线程未处于单线程单元 (STA) 模式下。 请将 STAThreadAttribute 添加到应用程序的 Main 方法中。

InvalidEnumArgumentException

format 不是有效的 TextDataFormat 值。

示例

以下示例演示此成员。

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

注解

ContainsText在使用此方法检索剪贴板之前，请使用 方法确定剪贴板是否包含文本数据。

SetText使用 方法将文本数据添加到剪贴板。

注意

Clipboard 类只能在设置为单线程单元 (STA) 模式的线程中使用。 若要使用此类，请确保使用 Main 特性标记 STAThreadAttribute 方法。

另请参阅

• TextDataFormat
• ContainsText
• SetText