Export (0) Print
Expand All

Clipboard.SetText Method (String, TextDataFormat)

Note: This method is new in the .NET Framework version 2.0.

Adds text data to 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 void SetText (
	string text,
	TextDataFormat format
)
public static void SetText (
	String text, 
	TextDataFormat format
)
public static function SetText (
	text : String, 
	format : TextDataFormat
)

Parameters

text

The text to add to the Clipboard.

format

One of the TextDataFormat values.

Exception typeCondition

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 a null reference (Nothing in Visual Basic) 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 image data before retrieving it with the GetText method.

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

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2015 Microsoft