Clipboard.SetText Method

Definition

Clears the Clipboard and then adds text data to it.

Overloads

SetText(String)

Clears the Clipboard and then adds text data in the Text or UnicodeText format, depending on the operating system.

SetText(String, TextDataFormat)

Clears the Clipboard and then adds text data in the format indicated by the specified TextDataFormat value.

SetText(String)

Source:
Clipboard.cs
Source:
Clipboard.cs
Source:
Clipboard.cs

Clears the Clipboard and then adds text data in the Text or UnicodeText format, depending on the operating system.

C#
public static void SetText(string text);

Parameters

text
String

The text to add to the Clipboard.

Exceptions

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

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

text is null or Empty.

Examples

The following example demonstrates an overload of the SetText method that is similar to this overload.

C#
// 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;
}

Remarks

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

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.

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.

See also

Applies to

.NET Framework 4.8.1 and other versions
Product Versions
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9

SetText(String, TextDataFormat)

Source:
Clipboard.cs
Source:
Clipboard.cs
Source:
Clipboard.cs

Clears the Clipboard and then adds text data in the format indicated by the specified TextDataFormat value.

C#
public static void SetText(string text, System.Windows.Forms.TextDataFormat format);

Parameters

text
String

The text to add to the Clipboard.

format
TextDataFormat

One of the TextDataFormat values.

Exceptions

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

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

text is null or Empty.

format is not a valid TextDataFormat value.

Examples

The following example demonstrates this member.

C#
// 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;
}

Remarks

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.

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.

See also

Applies to

.NET Framework 4.8.1 and other versions
Product Versions
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9