Clipboard.SetText 方法
重要
部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。
清除剪貼簿，然後將文字資料加入其中。
| SetText(String) |
清除剪貼簿，然後依作業系統而定加入 Text 或 UnicodeText 格式的文字資料。 |
| SetText(String, TextDataFormat) |
清除剪貼簿，然後加入指定之 TextDataFormat 值所表示格式的文字資料。 |
清除剪貼簿，然後依作業系統而定加入 Text 或 UnicodeText 格式的文字資料。
public:
static void SetText(System::String ^ text);public static void SetText (string text);static member SetText : string -> unitPublic Shared Sub SetText (text As String)參數
- text
- String
要加入至剪貼簿的文字。
例外狀況
無法清除剪貼簿。 這通常在剪貼簿由另一個處理序使用時發生。
目前執行緒 (Thread) 不是在單一執行緒 Apartment (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 只能在設定為單一線程 Apartment (STA) 模式的執行緒中使用。 若要使用這個類別，請確定您的 Main 方法已標示 STAThreadAttribute 為 屬性。
另請參閱
適用於
.NET Framework 4.8.1 及其他版本
| 產品 | 版本 |
|---|---|
| .NET Framework | 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
| Windows Desktop | 3.0, 3.1, 5, 6, 7, 8, 9 |
清除剪貼簿，然後加入指定之 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 -> unitPublic Shared Sub SetText (text As String, format As TextDataFormat)參數
- text
- String
要加入至剪貼簿的文字。
- format
- TextDataFormat
其中一個 TextDataFormat 值。
例外狀況
無法清除剪貼簿。 這通常在剪貼簿由另一個處理序使用時發生。
目前執行緒 (Thread) 不是在單一執行緒 Apartment (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 只能在設定為單一線程 Apartment (STA) 模式的執行緒中使用。 若要使用這個類別，請確定您的 Main 方法已標示 STAThreadAttribute 為 屬性。
另請參閱
適用於
.NET Framework 4.8.1 及其他版本
| 產品 | 版本 |
|---|---|
| .NET Framework | 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
| Windows Desktop | 3.0, 3.1, 5, 6, 7, 8, 9 |
