Adds text data to the Clipboard in the format indicated by the specified TextDataFormat value.
(in System.Windows.Forms.dll)
Visual Basic (Declaration)
Public Shared Sub SetText ( _
text As String, _
format As TextDataFormat _
)
Dim text As String
Dim format As TextDataFormat
Clipboard.SetText(text, format)
public static void SetText(
string text,
TextDataFormat format
)
public:
static void SetText(
String^ text,
TextDataFormat format
)
public static function SetText(
text : String,
format : TextDataFormat
)
To retrieve text data from the Clipboard, first use the ContainsText method to determine whether the Clipboard contains text 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 this member.
' 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 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
.NET Framework
Supported in: 3.5, 3.0, 2.0
Reference