Clipboard.SetText 方法

定义

命名空间:

System.Windows.Forms

程序集:

System.Windows.Forms.dll

清除剪贴板然后，然后在其中添加文本数据。

重载

SetText(String)	清除剪贴板然后，然后以 Text 或 UnicodeText 格式添加文本数据，这取决于操作系统。
SetText(String, TextDataFormat)	除剪贴板然后，然后以所指定 TextDataFormat 值指示的格式添加文本数据。

SetText(String)

清除剪贴板然后，然后以 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

要添加到剪贴板中的文本。

例外

ExternalException

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

ThreadStateException

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

ArgumentNullException

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

注解

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

若要从剪贴板检索文本数据，请先使用 ContainsText 方法确定剪贴板是否包含文本数据，然后再使用 GetText 方法检索它。

注意

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

另请参阅

• TextDataFormat
• ContainsText
• GetText

SetText(String, TextDataFormat)

除剪贴板然后，然后以所指定 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 值之一。

例外

ExternalException

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

ThreadStateException

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

ArgumentNullException

text 是 null 或 Empty。

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

注意

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

另请参阅

• TextDataFormat
• ContainsText
• GetText