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

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

另請參閱

適用於

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

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

另請參閱

適用於