Clipboard.SetText Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Clears the Clipboard and then adds text data to it.
Overloads
| SetText(String) |
Clears the Clipboard and then adds text data in the Text or UnicodeText format, depending on the operating system. |
| SetText(String, TextDataFormat) |
Clears the Clipboard and then adds text data in the format indicated by the specified TextDataFormat value. |
SetText(String)
Clears the Clipboard and then adds text data in the Text or UnicodeText format, depending on the operating system.
public:
static void SetText(System::String ^ text);public static void SetText (string text);static member SetText : string -> unitPublic Shared Sub SetText (text As String)Parameters
- text
- String
The text to add to the Clipboard.
Exceptions
The Clipboard could not be cleared. This typically occurs when the Clipboard is being used by another process.
The current thread is not in single-threaded apartment (STA) mode. Add the STAThreadAttribute to your application's Main method.
text is null or Empty.
Examples
The following example demonstrates an overload of the SetText method that is similar to this overload.
// 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
Remarks
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 text data before retrieving it with the GetText method.
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.
See also
Applies to
SetText(String, TextDataFormat)
Clears the Clipboard and then adds text data in the format indicated by the specified TextDataFormat value.
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)Parameters
- text
- String
The text to add to the Clipboard.
- format
- TextDataFormat
One of the TextDataFormat values.
Exceptions
The Clipboard could not be cleared. This typically occurs when the Clipboard is being used by another process.
The current thread is not in single-threaded apartment (STA) mode. Add the STAThreadAttribute to your application's Main method.
text is null or Empty.
format is not a valid TextDataFormat value.
Examples
The following example demonstrates this member.
// 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
Remarks
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.
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.
