Clipboard.SetText Method (String, TextDataFormat)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Clears the Clipboard and then adds text data in the format indicated by the specified TextDataFormat value.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

Public Shared Sub SetText (
	text As String,
	format As TextDataFormat


Type: System.String

The text to add to the Clipboard.

Type: System.Windows.Forms.TextDataFormat

One of the TextDataFormat values.

Exception Condition

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.

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.


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


for adding text data to the system Clipboard. Associated enumeration: UIPermissionClipboard.OwnClipboard

.NET Framework
Available since 2.0
Return to top