Clipboard.GetText 方法

定义

命名空间:
System.Windows.Forms
程序集:
System.Windows.Forms.dll

从剪贴板检索文本数据。

重载

名称 说明
GetText(TextDataFormat)

以指定 TextDataFormat 值指示的格式从剪贴板检索文本数据。
GetText()

根据操作系统，从剪贴板 Text 检索文本数据（ UnicodeText 或格式）。

GetText(TextDataFormat)

Source:
Clipboard.cs
Source:
Clipboard.cs
Source:
Clipboard.cs
Source:
Clipboard.cs
Source:
Clipboard.cs

以指定 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 方法。

另请参阅

适用于

GetText()

Source:
Clipboard.cs
Source:
Clipboard.cs
Source:
Clipboard.cs
Source:
Clipboard.cs
Source:
Clipboard.cs

根据操作系统，从剪贴板 Text 检索文本数据（ UnicodeText 或格式）。

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

返回

String

剪贴板文本数据，或者Empty剪贴板不包含格式TextUnicodeText的数据，具体取决于操作系统。

例外

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

注解

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

ContainsText使用此方法确定剪贴板是否包含文本数据，然后再使用此方法检索它。

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

注释

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

另请参阅

适用于