Clipboard::GetText Method ()
Retrieves text data from the Clipboard in the Text or UnicodeText format, depending on the operating system.
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
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.
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. |
for access to the system Clipboard. Associated enumeration: UIPermissionClipboard::AllClipboard
Available since 2.0
