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

目前執行緒 (Thread) 不是在單一執行緒 Apartment (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

備註

此方法會以 Windows XP Home Edition、Windows XP Professional、Windows Server 2003 和 Windows 2000 的格式新增文字資料 UnicodeText 。 否則，此方法會 Text 以 格式新增文字資料。

若要從剪貼簿擷取文字資料，請先使用 ContainsText 方法來判斷剪貼簿是否包含文字資料，然後再使用 方法擷 GetText 取。

注意

類別 Clipboard 只能在設定為單一線程 Apartment (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

目前執行緒 (Thread) 不是在單一執行緒 Apartment (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 只能在設定為單一線程 Apartment (STA) 模式的執行緒中使用。 若要使用這個類別，請確定您的 Main 方法已標示 STAThreadAttribute 為 屬性。

另請參閱

• TextDataFormat
• ContainsText
• GetText