Clipboard.SetData Method (System.Windows)

Switch View

SetData Method

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..::.SetData Method

Stores the specified data on the Clipboard in the specified format.

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

Syntax

Visual Basic (Declaration)

Public Shared Sub SetData ( _
    format As String, _
    data As Object _
)

Visual Basic (Usage)

Dim format As String
Dim data As Object

Clipboard.SetData(format, data)

public static void SetData(
    string format,
    Object data
)

Visual C++

public:
static void SetData(
    String^ format, 
    Object^ data
)

JScript

public static function SetData(
    format : String, 
    data : Object
)

XAML

You cannot use methods in XAML.

Parameters

format: Type: System..::.String
A string that specifies the format to use to store the data. See the DataFormats class for a set of predefined data formats.

data: Type: System..::.Object
An object representing the data to store on the Clipboard.

Remarks

This method adds data with auto-conversion enabled if the corresponding data format is FileDrop or Bitmap. Otherwise, auto-conversion is disabled.

Examples

The following example demonstrates the use of this method.

// For this example, the data to be placed on the clipboard is a simple
// string.
string textData = "I want to put this string on the clipboard.";

// After this call, the data (string) is placed on the clipboard and tagged
// with a data format of "Text".
Clipboard.SetData(DataFormats.Text, (Object)textData);

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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

Reference

Clipboard Class

Clipboard Members

System.Windows Namespace

ContainsData

GetData