语言

Clipboard.SetText 方法

定义

清除剪贴板,然后将文本数据添加到剪贴板。

重载

名称 说明
SetText(String)

清除剪贴板,然后根据操作系统以或Text格式添加文本数据UnicodeText。

SetText(String, TextDataFormat)

清除剪贴板,然后以指定 TextDataFormat 值指示的格式添加文本数据。

SetText(String)

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

清除剪贴板,然后根据操作系统以或Text格式添加文本数据UnicodeText。

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)

参数

text
String

要添加到剪贴板的文本。

例外

无法清除剪贴板。 当剪贴板被另一个进程使用时,通常会发生这种情况。

当前线程不在单线程单元(STA)模式下。 将它 STAThreadAttribute 添加到应用程序 Main 的方法。

text 是 null 或 Empty。

示例

以下示例演示与此重载类似的方法的 SetText 重载。

// 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 该方法确定剪贴板是否包含文本数据,然后再使用 GetText 该方法检索它。

注释

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

另请参阅

适用于

SetText(String, TextDataFormat)

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

清除剪贴板,然后以指定 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)

参数

text
String

要添加到剪贴板的文本。

format
TextDataFormat

其中一个 TextDataFormat 值。

例外

无法清除剪贴板。 当剪贴板被另一个进程使用时,通常会发生这种情况。

当前线程不在单线程单元(STA)模式下。 将它 STAThreadAttribute 添加到应用程序 Main 的方法。

text 是 null 或 Empty。

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 该方法确定剪贴板是否包含文本数据,然后再使用 GetText 该方法检索它。

注释

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

另请参阅

适用于