This documentation is archived and is not being maintained.

IDataObject.GetDataPresent Method (String)

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(
	string format
)

Parameters

format
Type: System.String

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 data object using a string and the Text format. Then it verifies that the data is present in the Text format and displays the results in a message box. The example assumes that you have created a Form named Form1.

private void TestDataObject() 
{
    // Creates a new data object using a string and the Text format.
    string myString = "Hello World!";
    DataObject myDataObject = new DataObject(DataFormats.Text, myString);

    // Checks whether the data is present in the Text format and displays the result. 
    if (myDataObject.GetDataPresent(DataFormats.Text))
        MessageBox.Show("The stored data is in the Text format." , "Test Result");
    else
        MessageBox.Show("The stored data is not in the Text format.", "Test Result");
}

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: