Clipboard.SetText Method (String, TextDataFormat) (System.Windows.Forms)

SetText Method (String, TextDataFor...

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

Clipboard..::.SetText Method (String, TextDataFormat)

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)

Syntax

Visual Basic (Declaration)

Public Shared Sub SetText ( _
    text As String, _
    format As TextDataFormat _
)

Visual Basic (Usage)

Dim text As String
Dim format As TextDataFormat

Clipboard.SetText(text, format)

public static void SetText(
    string text,
    TextDataFormat format
)

Visual C++

public:
static void SetText(
    String^ text, 
    TextDataFormat format
)

JScript

public static function SetText(
    text : String, 
    format : TextDataFormat
)

Parameters

text: Type: System..::.String
The text to add to the Clipboard.

format: Type: System.Windows.Forms..::.TextDataFormat
One of the TextDataFormat values.

Exceptions

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 nullNothingnullptra null reference (Nothing in Visual Basic) or Empty.
InvalidEnumArgumentException	format is not a valid TextDataFormat value.

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.

Examples

The following example demonstrates this member.

Visual Basic

' Demonstrates SetText, ContainsText, and GetText.
Public Function SwapClipboardHtmlText( _
    ByVal replacementHtmlText As String) As String

    Dim returnHtmlText As String = Nothing

    If (Clipboard.ContainsText(TextDataFormat.Html)) Then
        returnHtmlText = Clipboard.GetText(TextDataFormat.Html)
        Clipboard.SetText(replacementHtmlText, TextDataFormat.Html)
    End If

    Return returnHtmlText

End Function

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

.NET Framework Security

UIPermission
for adding text data to the system Clipboard. Associated enumeration: UIPermissionClipboard..::.OwnClipboard

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

Clipboard Class

Clipboard Members

SetText Overload

System.Windows.Forms Namespace

TextDataFormat

ContainsText

GetText