Clipboard.GetText Method ()

 

Retrieves text data from 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)

Public Shared Function GetText As String

Return Value

Type: System.String

The Clipboard text data or String.Empty if the Clipboard does not contain data in the Text or UnicodeText format, depending on the operating system.

Exception Condition
ExternalException

The Clipboard could not be cleared. This typically occurs when the Clipboard is being used by another process.

ThreadStateException

The current thread is not in single-threaded apartment (STA) mode. Add the STAThreadAttribute to your application's Main method.

This method returns text data in the UnicodeText format on Windows XP Home Edition, Windows XP Professional, Windows Server 2003 and Windows 2000. Otherwise, this method returns text data in the Text format.

Use the ContainsText method to determine whether the Clipboard contains text data before retrieving it with this method.

Use the SetText method to add text data to the Clipboard.

System_CAPS_noteNote

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 GetText 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

UIPermission

for access to the system Clipboard. Associated enumeration: UIPermissionClipboard.AllClipboard

.NET Framework
Available since 2.0
Return to top
Show: