Clipboard::GetText Method (TextDataFormat)
Retrieves text data from the Clipboard in the format indicated by the specified TextDataFormat value.
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
Parameters
- format
-
Type:
System.Windows.Forms::TextDataFormat
One of the TextDataFormat values.
Return Value
Type: System::String^The Clipboard text data or String::Empty if the Clipboard does not contain data in the specified format.
| 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. |
| InvalidEnumArgumentException | format is not a valid TextDataFormat value. |
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
