SetText Method (String, TextDataFormat)
Collapse the table of content
Expand the table of content

Clipboard.SetText Method (String, TextDataFormat)

 

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 static void SetText(
	string text,
	TextDataFormat format
)

Parameters

text
Type: System.String

The text to add to the Clipboard.

format
Type: System.Windows.Forms.TextDataFormat

One of the TextDataFormat values.

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.

ArgumentNullException

text is null or Empty.

InvalidEnumArgumentException

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.

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 adding text data to the system Clipboard. Associated enumeration: UIPermissionClipboard.OwnClipboard

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft