DataObject.GetData Method (String, Boolean)

 

Returns the data associated with the specified data format, using an automated conversion parameter to determine whether to convert the data to the format.

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

abstract GetData : 
        format:string *
        autoConvert:bool -> Object
override GetData : 
        format:string *
        autoConvert:bool -> Object

Parameters

format
Type: System.String

The format of the data to retrieve. See DataFormats for predefined formats.

autoConvert
Type: System.Boolean

true to the convert data to the specified format; otherwise, false.

Return Value

Type: System.Object

The data associated with the specified format, or null.

If the autoConvert parameter is true and this method cannot find data in the specified format, it attempts to convert the data to the format. If the data cannot be converted to the specified format, or if the data was stored with the automatic conversion set to false, this method returns null.

If the autoConvert parameter is false, this method returns data in the specified format, or null if no data in this format can be found.

To determine whether data is associated with, or can be converted to, a format, call GetDataPresent before calling GetData. Call GetFormats for a list of valid formats for the data stored in this DataObject.

System_CAPS_noteNote

Data can be converted to another format if it was stored specifying that conversion is allowed, and if the requested format is compatible with the stored format. For example, data stored as Unicode can be converted to text.

When format is Html, this method returns a UTF-8 encoded string in applications that target .NET 4.5 or higher, and an ANSI encoded string in applications that target .NET 4.0 or lower.

The following code example retrieves the data stored in a DataObject, using the autoConvert parameter to specify whether to convert the data format.

First, a new DataObject is created with text data. Then the example tries to retrieve the data, specifying its format as a string and no format conversion, that is, the autoConvert parameter is false. This operation fails because there is no string data in the DataObject.

Next, the example tries to retrieve the data again, with the autoConvert parameter set to true. This operation succeeds and the results are displayed in a MessageBox.

This code requires that textBox1 has been created.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 1.1
Return to top
Show: