Note: This method is new in the .NET Framework version 2.0.
Adds text data to the Clipboard in the
Text or
UnicodeText format, depending on the operating system.
Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)
Visual Basic (Declaration)
Public Shared Sub SetText ( _
text As String _
)
Dim text As String
Clipboard.SetText(text)
public static void SetText (
string text
)
public:
static void SetText (
String^ text
)
public static void SetText (
String text
)
public static function SetText (
text : String
)
Parameters
- text
The text to add to the Clipboard.
This method adds text data in the UnicodeText format on Windows XP Home Edition, Windows XP Professional, Windows Server 2003 and Windows 2000. Otherwise, this method adds text data in the Text format.
To retrieve text data from the Clipboard, first use the ContainsText method to determine whether the Clipboard contains image data before retrieving it with the GetText method.
.gif) Note |
|---|
| The Clipboard class can only be used in threads set to single thread apartment (STA) mode. To use this class, ensure that your Main method is marked with the STAThreadAttribute attribute. |
The following example demonstrates an overload of the SetText method that is similar to this overload.
' 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
// 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;
}
Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.
.NET Framework
Supported in: 2.0