Clipboard.GetText Method (TextDataFormat)

 

Retrieves text data from the Clipboard in the format indicated by the specified TextDataFormat value.

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

public static string GetText(
	TextDataFormat format
)

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.

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 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;
}

UIPermission

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

.NET Framework
Available since 2.0
Return to top
Show: