This documentation is archived and is not being maintained.

IDataObject.GetDataPresent Method (Type)

Determines whether data stored in this instance is associated with, or can be converted to, the specified format.

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

bool GetDataPresent(
	Type format
)

Parameters

format
Type: System.Type

A Type representing the format for which to check. See DataFormats for predefined formats.

Return Value

Type: System.Boolean
true if data stored in this instance is associated with, or can be converted to, the specified format; otherwise, false.

Call this method to determine whether a format exists in this DataObject before calling GetData. Call GetFormats for the formats that are available in this instance.

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.

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

This example uses the DataObject class, which implements IDataObject, to demonstrate the use of the GetDataPresent method. First, it creates a component (myComponent) and stores it in a data object (myDataObject). Then it checks whether the specified data is stored in myDataObject. If the test evaluates true, it displays the result in a message box and displays the data type in a text box. This example assumes that you have already created a Form named Form1 and a TextBox named textBox1.

private void GetDataPresent2() 
{
    // Creates a component to store in the data object.
    Component myComponent = new Component();

    // Creates a new data object and assigns it the component.
    DataObject myDataObject = new DataObject(myComponent);

    // Creates a type to store the type of data.
    Type myType = myComponent.GetType();

    // Checks whether the specified data type exists in the object. 
    if (myDataObject.GetDataPresent(myType))
    {
        MessageBox.Show("The specified data is stored in the data object.");
        // Displays the type of data.
        textBox1.Text = "The data type is " + myDataObject.GetData(myType).GetType().Name + ".";
    }
    else
        MessageBox.Show("The specified data is not stored in the data object.");
}

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, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

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.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0
Show: