Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
SetData Method (String, Boolean, Object)

IDataObject.SetData Method (String, Boolean, Object)

Stores the specified data and its associated format in this instance, using a Boolean value to specify whether the data can be converted to another format.

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

void SetData(
	string format,
	bool autoConvert,
	Object data
)

Parameters

format
Type: System.String

The format associated with the data. See DataFormats for predefined formats.

autoConvert
Type: System.Boolean

true to allow the data to be converted to another format; otherwise, false.

data
Type: System.Object

The data to store.

If you do not know the format of the target application, you can store data in multiple formats using this method.

For an implementation of this method, see DataObject.SetData.

This example uses the DataObject class, which implements IDataObject, to demonstrate the use of the SetData method. First, it creates a data object (myDataObject) and stores a UnicodeText string in it, with the autoConvert parameter set to false. Then it retrieves the format(s) associated with the data stored in the object and displays the result in a message box. The only format associated with the data is the UnicodeText format. This example assumes that you have created a Form named Form1.

private void SetData4() 
{
    // Creates a new data object.
    DataObject myDataObject = new DataObject();

    // Adds UnicodeText string to the object, and set the autoConvert  
    // parameter to false.
    myDataObject.SetData(DataFormats.UnicodeText, false, "My text string");

    // Gets the data format(s) in the data object.
    String[] arrayOfFormats = myDataObject.GetFormats();

    // Stores the results in a string. 
    string theResult = "The format(s) associated with the data are:" + '\n';
    for(int i=0; i<arrayOfFormats.Length; i++)
        theResult += arrayOfFormats[i] + '\n';

    // Show the results in a message box. 
    MessageBox.Show(theResult);

}

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft